mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-11 07:58:06 -05:00
Compare commits
1 Commits
v0.5.26
...
fix/slack-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f6bc5eaeac |
@@ -1,45 +0,0 @@
|
||||
---
|
||||
description: EMCN component library patterns with CVA
|
||||
globs: ["apps/sim/components/emcn/**"]
|
||||
---
|
||||
|
||||
# EMCN Component Guidelines
|
||||
|
||||
## When to Use CVA vs Direct Styles
|
||||
|
||||
**Use CVA (class-variance-authority) when:**
|
||||
- 2+ visual variants (primary, secondary, outline)
|
||||
- Multiple sizes or state variations
|
||||
- Example: Button with variants
|
||||
|
||||
**Use direct className when:**
|
||||
- Single consistent style
|
||||
- No variations needed
|
||||
- Example: Label with one style
|
||||
|
||||
## Patterns
|
||||
|
||||
**With CVA:**
|
||||
```tsx
|
||||
const buttonVariants = cva('base-classes', {
|
||||
variants: {
|
||||
variant: { default: '...', primary: '...' },
|
||||
size: { sm: '...', md: '...' }
|
||||
}
|
||||
})
|
||||
export { Button, buttonVariants }
|
||||
```
|
||||
|
||||
**Without CVA:**
|
||||
```tsx
|
||||
function Label({ className, ...props }) {
|
||||
return <Primitive className={cn('single-style-classes', className)} {...props} />
|
||||
}
|
||||
```
|
||||
|
||||
## Rules
|
||||
- Use Radix UI primitives for accessibility
|
||||
- Export component and variants (if using CVA)
|
||||
- TSDoc with usage examples
|
||||
- Consistent tokens: `font-medium`, `text-[12px]`, `rounded-[4px]`
|
||||
- Always use `transition-colors` for hover states
|
||||
@@ -1,20 +0,0 @@
|
||||
---
|
||||
description: Global coding standards that apply to all files
|
||||
alwaysApply: true
|
||||
---
|
||||
|
||||
# Global Standards
|
||||
|
||||
You are a professional software engineer. All code must follow best practices: accurate, readable, clean, and efficient.
|
||||
|
||||
## Logging
|
||||
Use `logger.info`, `logger.warn`, `logger.error` instead of `console.log`.
|
||||
|
||||
## Comments
|
||||
Use TSDoc for documentation. No `====` separators. No non-TSDoc comments.
|
||||
|
||||
## Styling
|
||||
Never update global styles. Keep all styling local to components.
|
||||
|
||||
## Package Manager
|
||||
Use `bun` and `bunx`, not `npm` and `npx`.
|
||||
@@ -1,67 +0,0 @@
|
||||
---
|
||||
description: Core architecture principles for the Sim app
|
||||
globs: ["apps/sim/**"]
|
||||
---
|
||||
|
||||
# Sim App Architecture
|
||||
|
||||
## Core Principles
|
||||
1. **Single Responsibility**: Each component, hook, store has one clear purpose
|
||||
2. **Composition Over Complexity**: Break down complex logic into smaller pieces
|
||||
3. **Type Safety First**: TypeScript interfaces for all props, state, return types
|
||||
4. **Predictable State**: Zustand for global state, useState for UI-only concerns
|
||||
5. **Performance by Default**: useMemo, useCallback, refs appropriately
|
||||
|
||||
## File Organization
|
||||
|
||||
```
|
||||
feature/
|
||||
├── components/ # Feature components
|
||||
│ └── sub-feature/ # Sub-feature with own components
|
||||
├── hooks/ # Custom hooks
|
||||
└── feature.tsx # Main component
|
||||
```
|
||||
|
||||
## Naming Conventions
|
||||
- **Components**: PascalCase (`WorkflowList`, `TriggerPanel`)
|
||||
- **Hooks**: camelCase with `use` prefix (`useWorkflowOperations`)
|
||||
- **Files**: kebab-case matching export (`workflow-list.tsx`)
|
||||
- **Stores**: kebab-case in stores/ (`sidebar/store.ts`)
|
||||
- **Constants**: SCREAMING_SNAKE_CASE
|
||||
- **Interfaces**: PascalCase with suffix (`WorkflowListProps`)
|
||||
|
||||
## State Management
|
||||
|
||||
**useState**: UI-only concerns (dropdown open, hover, form inputs)
|
||||
**Zustand**: Shared state, persistence, global app state
|
||||
**useRef**: DOM refs, avoiding dependency issues, mutable non-reactive values
|
||||
|
||||
## Component Extraction
|
||||
|
||||
**Extract to separate file when:**
|
||||
- Complex (50+ lines)
|
||||
- Used across 2+ files
|
||||
- Has own state/logic
|
||||
|
||||
**Keep inline when:**
|
||||
- Simple (< 10 lines)
|
||||
- Used in only 1 file
|
||||
- Purely presentational
|
||||
|
||||
**Never import utilities from another component file.** Extract shared helpers to `lib/` or `utils/`.
|
||||
|
||||
## Utils Files
|
||||
|
||||
**Never create a `utils.ts` file for a single consumer.** Inline the logic directly in the consuming component.
|
||||
|
||||
**Create `utils.ts` when:**
|
||||
- 2+ files import the same helper
|
||||
|
||||
**Prefer existing sources of truth:**
|
||||
- Before duplicating logic, check if a centralized helper already exists (e.g., `lib/logs/get-trigger-options.ts`)
|
||||
- Import from the source of truth rather than creating wrapper functions
|
||||
|
||||
**Location hierarchy:**
|
||||
- `lib/` — App-wide utilities (auth, billing, core)
|
||||
- `feature/utils.ts` — Feature-scoped utilities (used by 2+ components in the feature)
|
||||
- Inline — Single-use helpers (define directly in the component)
|
||||
@@ -1,64 +0,0 @@
|
||||
---
|
||||
description: Component patterns and structure for React components
|
||||
globs: ["apps/sim/**/*.tsx"]
|
||||
---
|
||||
|
||||
# Component Patterns
|
||||
|
||||
## Structure Order
|
||||
```typescript
|
||||
'use client' // Only if using hooks
|
||||
|
||||
// 1. Imports (external → internal → relative)
|
||||
// 2. Constants at module level
|
||||
const CONFIG = { SPACING: 8 } as const
|
||||
|
||||
// 3. Props interface with TSDoc
|
||||
interface ComponentProps {
|
||||
/** Description */
|
||||
requiredProp: string
|
||||
optionalProp?: boolean
|
||||
}
|
||||
|
||||
// 4. Component with TSDoc
|
||||
export function Component({ requiredProp, optionalProp = false }: ComponentProps) {
|
||||
// a. Refs
|
||||
// b. External hooks (useParams, useRouter)
|
||||
// c. Store hooks
|
||||
// d. Custom hooks
|
||||
// e. Local state
|
||||
// f. useMemo computations
|
||||
// g. useCallback handlers
|
||||
// h. useEffect
|
||||
// i. Return JSX
|
||||
}
|
||||
```
|
||||
|
||||
## Rules
|
||||
1. Add `'use client'` when using React hooks
|
||||
2. Always define props interface
|
||||
3. TSDoc on component: description, @param, @returns
|
||||
4. Extract constants with `as const`
|
||||
5. Use Tailwind only, no inline styles
|
||||
6. Semantic HTML (`aside`, `nav`, `article`)
|
||||
7. Include ARIA attributes where appropriate
|
||||
8. Optional chain callbacks: `onAction?.(id)`
|
||||
|
||||
## Factory Pattern with Caching
|
||||
|
||||
When generating components for a specific signature (e.g., icons):
|
||||
|
||||
```typescript
|
||||
const cache = new Map<string, React.ComponentType<{ className?: string }>>()
|
||||
|
||||
function getColorIcon(color: string) {
|
||||
if (cache.has(color)) return cache.get(color)!
|
||||
|
||||
const Icon = ({ className }: { className?: string }) => (
|
||||
<div className={cn(className, 'rounded-[3px]')} style={{ backgroundColor: color, width: 10, height: 10 }} />
|
||||
)
|
||||
Icon.displayName = `ColorIcon(${color})`
|
||||
cache.set(color, Icon)
|
||||
return Icon
|
||||
}
|
||||
```
|
||||
@@ -1,68 +0,0 @@
|
||||
---
|
||||
description: Custom hook patterns and best practices
|
||||
globs: ["apps/sim/**/use-*.ts", "apps/sim/**/hooks/**/*.ts"]
|
||||
---
|
||||
|
||||
# Hook Patterns
|
||||
|
||||
## Structure
|
||||
```typescript
|
||||
import { createLogger } from '@/lib/logs/console/logger'
|
||||
|
||||
const logger = createLogger('useFeatureName')
|
||||
|
||||
interface UseFeatureProps {
|
||||
id: string
|
||||
onSuccess?: (result: Result) => void
|
||||
}
|
||||
|
||||
/**
|
||||
* Hook description.
|
||||
* @param props - Configuration
|
||||
* @returns State and operations
|
||||
*/
|
||||
export function useFeature({ id, onSuccess }: UseFeatureProps) {
|
||||
// 1. Refs for stable dependencies
|
||||
const idRef = useRef(id)
|
||||
const onSuccessRef = useRef(onSuccess)
|
||||
|
||||
// 2. State
|
||||
const [data, setData] = useState<Data | null>(null)
|
||||
const [isLoading, setIsLoading] = useState(false)
|
||||
const [error, setError] = useState<Error | null>(null)
|
||||
|
||||
// 3. Sync refs
|
||||
useEffect(() => {
|
||||
idRef.current = id
|
||||
onSuccessRef.current = onSuccess
|
||||
}, [id, onSuccess])
|
||||
|
||||
// 4. Operations with useCallback
|
||||
const fetchData = useCallback(async () => {
|
||||
setIsLoading(true)
|
||||
try {
|
||||
const result = await fetch(`/api/${idRef.current}`).then(r => r.json())
|
||||
setData(result)
|
||||
onSuccessRef.current?.(result)
|
||||
} catch (err) {
|
||||
setError(err as Error)
|
||||
logger.error('Failed', { error: err })
|
||||
} finally {
|
||||
setIsLoading(false)
|
||||
}
|
||||
}, []) // Empty deps - using refs
|
||||
|
||||
// 5. Return grouped by state/operations
|
||||
return { data, isLoading, error, fetchData }
|
||||
}
|
||||
```
|
||||
|
||||
## Rules
|
||||
1. Single responsibility per hook
|
||||
2. Props interface required
|
||||
3. TSDoc required
|
||||
4. Use logger, not console.log
|
||||
5. Refs for stable callback dependencies
|
||||
6. Wrap returned functions in useCallback
|
||||
7. Always try/catch async operations
|
||||
8. Track loading/error states
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
description: Import patterns for the Sim application
|
||||
globs: ["apps/sim/**/*.ts", "apps/sim/**/*.tsx"]
|
||||
---
|
||||
|
||||
# Import Patterns
|
||||
|
||||
## EMCN Components
|
||||
Import from `@/components/emcn`, never from subpaths like `@/components/emcn/components/modal/modal`.
|
||||
|
||||
**Exception**: CSS imports use actual file paths: `import '@/components/emcn/components/code/code.css'`
|
||||
|
||||
## Feature Components
|
||||
Import from central folder indexes, not specific subfolders:
|
||||
```typescript
|
||||
// ✅ Correct
|
||||
import { Dashboard, Sidebar } from '@/app/workspace/[workspaceId]/logs/components'
|
||||
|
||||
// ❌ Wrong
|
||||
import { Dashboard } from '@/app/workspace/[workspaceId]/logs/components/dashboard'
|
||||
```
|
||||
|
||||
## Internal vs External
|
||||
- **Cross-feature**: Absolute paths through central index
|
||||
- **Within feature**: Relative paths (`./components/...`, `../utils`)
|
||||
|
||||
## Import Order
|
||||
1. React/core libraries
|
||||
2. External libraries
|
||||
3. UI components (`@/components/emcn`, `@/components/ui`)
|
||||
4. Utilities (`@/lib/...`)
|
||||
5. Feature imports from indexes
|
||||
6. Relative imports
|
||||
7. CSS imports
|
||||
|
||||
## Types
|
||||
Use `type` keyword: `import type { WorkflowLog } from '...'`
|
||||
@@ -1,57 +0,0 @@
|
||||
---
|
||||
description: Zustand store patterns
|
||||
globs: ["apps/sim/**/store.ts", "apps/sim/**/stores/**/*.ts"]
|
||||
---
|
||||
|
||||
# Zustand Store Patterns
|
||||
|
||||
## Structure
|
||||
```typescript
|
||||
import { create } from 'zustand'
|
||||
import { persist } from 'zustand/middleware'
|
||||
|
||||
interface FeatureState {
|
||||
// State
|
||||
items: Item[]
|
||||
activeId: string | null
|
||||
|
||||
// Actions
|
||||
setItems: (items: Item[]) => void
|
||||
addItem: (item: Item) => void
|
||||
clearState: () => void
|
||||
}
|
||||
|
||||
const createInitialState = () => ({
|
||||
items: [],
|
||||
activeId: null,
|
||||
})
|
||||
|
||||
export const useFeatureStore = create<FeatureState>()(
|
||||
persist(
|
||||
(set) => ({
|
||||
...createInitialState(),
|
||||
|
||||
setItems: (items) => set({ items }),
|
||||
|
||||
addItem: (item) => set((state) => ({
|
||||
items: [...state.items, item],
|
||||
})),
|
||||
|
||||
clearState: () => set(createInitialState()),
|
||||
}),
|
||||
{
|
||||
name: 'feature-state',
|
||||
partialize: (state) => ({ items: state.items }),
|
||||
}
|
||||
)
|
||||
)
|
||||
```
|
||||
|
||||
## Rules
|
||||
1. Interface includes state and actions
|
||||
2. Extract config to module constants
|
||||
3. TSDoc on store
|
||||
4. Only persist what's needed
|
||||
5. Immutable updates only - never mutate
|
||||
6. Use `set((state) => ...)` when depending on previous state
|
||||
7. Provide clear/reset actions
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
description: Tailwind CSS and styling conventions
|
||||
globs: ["apps/sim/**/*.tsx", "apps/sim/**/*.css"]
|
||||
---
|
||||
|
||||
# Styling Rules
|
||||
|
||||
## Tailwind
|
||||
1. **No inline styles** - Use Tailwind classes exclusively
|
||||
2. **No duplicate dark classes** - Don't add `dark:` when value matches light mode
|
||||
3. **Exact values** - Use design system values (`text-[14px]`, `h-[25px]`)
|
||||
4. **Prefer px** - Use `px-[4px]` over `px-1`
|
||||
5. **Transitions** - Add `transition-colors` for interactive states
|
||||
|
||||
## Conditional Classes
|
||||
```typescript
|
||||
import { cn } from '@/lib/utils'
|
||||
|
||||
<div className={cn(
|
||||
'base-classes',
|
||||
isActive && 'active-classes',
|
||||
disabled ? 'opacity-60' : 'hover:bg-accent'
|
||||
)} />
|
||||
```
|
||||
|
||||
## CSS Variables for Dynamic Styles
|
||||
```typescript
|
||||
// In store setter
|
||||
setSidebarWidth: (width) => {
|
||||
set({ sidebarWidth: width })
|
||||
document.documentElement.style.setProperty('--sidebar-width', `${width}px`)
|
||||
}
|
||||
|
||||
// In component
|
||||
<aside style={{ width: 'var(--sidebar-width)' }} />
|
||||
```
|
||||
|
||||
## Anti-Patterns
|
||||
```typescript
|
||||
// ❌ Bad
|
||||
<div style={{ width: 200 }}>
|
||||
<div className='text-[var(--text-primary)] dark:text-[var(--text-primary)]'>
|
||||
|
||||
// ✅ Good
|
||||
<div className='w-[200px]'>
|
||||
<div className='text-[var(--text-primary)]'>
|
||||
```
|
||||
@@ -1,24 +0,0 @@
|
||||
---
|
||||
description: TypeScript conventions and type safety
|
||||
globs: ["apps/sim/**/*.ts", "apps/sim/**/*.tsx"]
|
||||
---
|
||||
|
||||
# TypeScript Rules
|
||||
|
||||
1. **No `any`** - Use proper types or `unknown` with type guards
|
||||
2. **Props interface** - Always define, even for simple components
|
||||
3. **Callback types** - Full signature with params and return type
|
||||
4. **Generics** - Use for reusable components/hooks
|
||||
5. **Const assertions** - `as const` for constant objects/arrays
|
||||
6. **Ref types** - Explicit: `useRef<HTMLDivElement>(null)`
|
||||
|
||||
## Anti-Patterns
|
||||
```typescript
|
||||
// ❌ Bad
|
||||
const handleClick = (e: any) => {}
|
||||
useEffect(() => { doSomething(prop) }, []) // Missing dep
|
||||
|
||||
// ✅ Good
|
||||
const handleClick = (e: React.MouseEvent<HTMLButtonElement>) => {}
|
||||
useEffect(() => { doSomething(prop) }, [prop])
|
||||
```
|
||||
19
.cursorrules
Normal file
19
.cursorrules
Normal file
@@ -0,0 +1,19 @@
|
||||
# Role
|
||||
|
||||
You are a professional software engineer. All code you write MUST follow best practices, ensuring accuracy, quality, readability, and cleanliness. You MUST make FOCUSED EDITS that are EFFICIENT and ELEGANT.
|
||||
|
||||
## Logs
|
||||
|
||||
ENSURE that you use the logger.info and logger.warn and logger.error instead of the console.log whenever you want to display logs.
|
||||
|
||||
## Comments
|
||||
|
||||
You must use TSDOC for comments. Do not use ==== for comments to separate sections. Do not leave any comments that are not TSDOC.
|
||||
|
||||
## Globals styles
|
||||
|
||||
You should not update the global styles unless it is absolutely necessary. Keep all styling local to components and files.
|
||||
|
||||
## Bun
|
||||
|
||||
Use bun and bunx not npm and npx
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -67,9 +67,6 @@ start-collector.sh
|
||||
# VSCode
|
||||
.vscode
|
||||
|
||||
# IntelliJ
|
||||
.idea
|
||||
|
||||
## Helm Chart Tests
|
||||
helm/sim/test
|
||||
i18n.cache
|
||||
|
||||
47
CLAUDE.md
47
CLAUDE.md
@@ -1,47 +0,0 @@
|
||||
# Expert Programming Standards
|
||||
|
||||
**You are tasked with implementing solutions that follow best practices. You MUST be accurate, elegant, and efficient as an expert programmer.**
|
||||
|
||||
---
|
||||
|
||||
# Role
|
||||
|
||||
You are a professional software engineer. All code you write MUST follow best practices, ensuring accuracy, quality, readability, and cleanliness. You MUST make FOCUSED EDITS that are EFFICIENT and ELEGANT.
|
||||
|
||||
## Logs
|
||||
|
||||
ENSURE that you use the logger.info and logger.warn and logger.error instead of the console.log whenever you want to display logs.
|
||||
|
||||
## Comments
|
||||
|
||||
You must use TSDOC for comments. Do not use ==== for comments to separate sections. Do not leave any comments that are not TSDOC.
|
||||
|
||||
## Global Styles
|
||||
|
||||
You should not update the global styles unless it is absolutely necessary. Keep all styling local to components and files.
|
||||
|
||||
## Bun
|
||||
|
||||
Use bun and bunx not npm and npx.
|
||||
|
||||
## Code Quality
|
||||
|
||||
- Write clean, maintainable code that follows the project's existing patterns
|
||||
- Prefer composition over inheritance
|
||||
- Keep functions small and focused on a single responsibility
|
||||
- Use meaningful variable and function names
|
||||
- Handle errors gracefully and provide useful error messages
|
||||
- Write type-safe code with proper TypeScript types
|
||||
|
||||
## Testing
|
||||
|
||||
- Write tests for new functionality when appropriate
|
||||
- Ensure existing tests pass before completing work
|
||||
- Follow the project's testing conventions
|
||||
|
||||
## Performance
|
||||
|
||||
- Consider performance implications of your code
|
||||
- Avoid unnecessary re-renders in React components
|
||||
- Use appropriate data structures and algorithms
|
||||
- Profile and optimize when necessary
|
||||
@@ -6,10 +6,9 @@ import Link from 'next/link'
|
||||
import { notFound } from 'next/navigation'
|
||||
import { PageNavigationArrows } from '@/components/docs-layout/page-navigation-arrows'
|
||||
import { TOCFooter } from '@/components/docs-layout/toc-footer'
|
||||
import { LLMCopyButton } from '@/components/page-actions'
|
||||
import { StructuredData } from '@/components/structured-data'
|
||||
import { CodeBlock } from '@/components/ui/code-block'
|
||||
import { Heading } from '@/components/ui/heading'
|
||||
import { CopyPageButton } from '@/components/ui/copy-page-button'
|
||||
import { source } from '@/lib/source'
|
||||
|
||||
export default async function Page(props: { params: Promise<{ slug?: string[]; lang: string }> }) {
|
||||
@@ -203,7 +202,7 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
|
||||
<div className='relative mt-6 sm:mt-0'>
|
||||
<div className='absolute top-1 right-0 flex items-center gap-2'>
|
||||
<div className='hidden sm:flex'>
|
||||
<LLMCopyButton markdownUrl={`${page.url}.mdx`} />
|
||||
<CopyPageButton markdownUrl={`${page.url}.mdx`} />
|
||||
</div>
|
||||
<PageNavigationArrows previous={neighbours?.previous} next={neighbours?.next} />
|
||||
</div>
|
||||
@@ -215,12 +214,6 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
|
||||
components={{
|
||||
...defaultMdxComponents,
|
||||
CodeBlock,
|
||||
h1: (props) => <Heading as='h1' {...props} />,
|
||||
h2: (props) => <Heading as='h2' {...props} />,
|
||||
h3: (props) => <Heading as='h3' {...props} />,
|
||||
h4: (props) => <Heading as='h4' {...props} />,
|
||||
h5: (props) => <Heading as='h5' {...props} />,
|
||||
h6: (props) => <Heading as='h6' {...props} />,
|
||||
}}
|
||||
/>
|
||||
</DocsBody>
|
||||
|
||||
@@ -2,12 +2,6 @@
|
||||
@import "fumadocs-ui/css/neutral.css";
|
||||
@import "fumadocs-ui/css/preset.css";
|
||||
|
||||
/* Prevent overscroll bounce effect on the page */
|
||||
html,
|
||||
body {
|
||||
overscroll-behavior: none;
|
||||
}
|
||||
|
||||
@theme {
|
||||
--color-fd-primary: #802fff; /* Purple from control-bar component */
|
||||
--font-geist-sans: var(--font-geist-sans);
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import { notFound } from 'next/navigation'
|
||||
import { type NextRequest, NextResponse } from 'next/server'
|
||||
import { i18n } from '@/lib/i18n'
|
||||
import { getLLMText } from '@/lib/llms'
|
||||
import { source } from '@/lib/source'
|
||||
|
||||
@@ -8,16 +7,7 @@ export const revalidate = false
|
||||
|
||||
export async function GET(_req: NextRequest, { params }: { params: Promise<{ slug?: string[] }> }) {
|
||||
const { slug } = await params
|
||||
|
||||
let lang: (typeof i18n.languages)[number] = i18n.defaultLanguage
|
||||
let pageSlug = slug
|
||||
|
||||
if (slug && slug.length > 0 && i18n.languages.includes(slug[0] as typeof lang)) {
|
||||
lang = slug[0] as typeof lang
|
||||
pageSlug = slug.slice(1)
|
||||
}
|
||||
|
||||
const page = source.getPage(pageSlug, lang)
|
||||
const page = source.getPage(slug)
|
||||
if (!page) notFound()
|
||||
|
||||
return new NextResponse(await getLLMText(page), {
|
||||
|
||||
@@ -4151,7 +4151,7 @@ export function DuckDuckGoIcon(props: SVGProps<SVGSVGElement>) {
|
||||
return (
|
||||
<svg {...props} xmlns='http://www.w3.org/2000/svg' viewBox='-108 -108 216 216'>
|
||||
<circle r='108' fill='#d53' />
|
||||
<circle r='96' fill='none' stroke='#ffffff' strokeWidth={7} />
|
||||
<circle r='96' fill='none' stroke='#ffffff' stroke-width='7' />
|
||||
<path
|
||||
d='M-32-55C-62-48-51-6-51-6l19 93 7 3M-39-73h-8l11 4s-11 0-11 7c24-1 35 5 35 5'
|
||||
fill='#ddd'
|
||||
@@ -4170,32 +4170,3 @@ export function DuckDuckGoIcon(props: SVGProps<SVGSVGElement>) {
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
|
||||
export function RssIcon(props: SVGProps<SVGSVGElement>) {
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
width='24'
|
||||
height='24'
|
||||
viewBox='0 0 24 24'
|
||||
fill='none'
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
>
|
||||
<path
|
||||
d='M4 11C6.38695 11 8.67613 11.9482 10.364 13.636C12.0518 15.3239 13 17.6131 13 20'
|
||||
stroke='currentColor'
|
||||
strokeWidth='2'
|
||||
strokeLinecap='round'
|
||||
strokeLinejoin='round'
|
||||
/>
|
||||
<path
|
||||
d='M4 4C8.24346 4 12.3131 5.68571 15.3137 8.68629C18.3143 11.6869 20 15.7565 20 20'
|
||||
stroke='currentColor'
|
||||
strokeWidth='2'
|
||||
strokeLinecap='round'
|
||||
strokeLinejoin='round'
|
||||
/>
|
||||
<circle cx='5' cy='19' r='1' fill='currentColor' />
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
|
||||
@@ -1,50 +1,55 @@
|
||||
'use client'
|
||||
|
||||
import { useState } from 'react'
|
||||
import { useCopyButton } from 'fumadocs-ui/utils/use-copy-button'
|
||||
import { Check, Copy } from 'lucide-react'
|
||||
|
||||
const cache = new Map<string, string>()
|
||||
|
||||
export function LLMCopyButton({
|
||||
markdownUrl,
|
||||
}: {
|
||||
/**
|
||||
* A URL to fetch the raw Markdown/MDX content of page
|
||||
*/
|
||||
interface CopyPageButtonProps {
|
||||
markdownUrl: string
|
||||
}) {
|
||||
}
|
||||
|
||||
export function CopyPageButton({ markdownUrl }: CopyPageButtonProps) {
|
||||
const [copied, setCopied] = useState(false)
|
||||
const [isLoading, setLoading] = useState(false)
|
||||
const [checked, onClick] = useCopyButton(async () => {
|
||||
|
||||
const handleCopy = async () => {
|
||||
const cached = cache.get(markdownUrl)
|
||||
if (cached) return navigator.clipboard.writeText(cached)
|
||||
if (cached) {
|
||||
await navigator.clipboard.writeText(cached)
|
||||
setCopied(true)
|
||||
setTimeout(() => setCopied(false), 2000)
|
||||
return
|
||||
}
|
||||
|
||||
setLoading(true)
|
||||
|
||||
try {
|
||||
await navigator.clipboard.write([
|
||||
new ClipboardItem({
|
||||
'text/plain': fetch(markdownUrl).then(async (res) => {
|
||||
const content = await res.text()
|
||||
cache.set(markdownUrl, content)
|
||||
|
||||
return content
|
||||
}),
|
||||
}),
|
||||
])
|
||||
setCopied(true)
|
||||
setTimeout(() => setCopied(false), 2000)
|
||||
} catch (err) {
|
||||
console.error('Failed to copy:', err)
|
||||
} finally {
|
||||
setLoading(false)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
return (
|
||||
<button
|
||||
disabled={isLoading}
|
||||
onClick={onClick}
|
||||
onClick={handleCopy}
|
||||
className='flex cursor-pointer items-center gap-1.5 rounded-lg border border-border/40 bg-background px-2.5 py-2 text-muted-foreground/60 text-sm leading-none transition-all hover:border-border hover:bg-accent/50 hover:text-muted-foreground'
|
||||
aria-label={checked ? 'Copied to clipboard' : 'Copy page content'}
|
||||
aria-label={copied ? 'Copied to clipboard' : 'Copy page content'}
|
||||
>
|
||||
{checked ? (
|
||||
{copied ? (
|
||||
<>
|
||||
<Check className='h-3.5 w-3.5' />
|
||||
<span>Copied</span>
|
||||
@@ -1,58 +0,0 @@
|
||||
'use client'
|
||||
|
||||
import { type ComponentPropsWithoutRef, useState } from 'react'
|
||||
import { Check, Link } from 'lucide-react'
|
||||
import { cn } from '@/lib/utils'
|
||||
|
||||
type HeadingTag = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'
|
||||
|
||||
interface HeadingProps extends ComponentPropsWithoutRef<'h1'> {
|
||||
as?: HeadingTag
|
||||
}
|
||||
|
||||
export function Heading({ as, className, ...props }: HeadingProps) {
|
||||
const [copied, setCopied] = useState(false)
|
||||
const As = as ?? 'h1'
|
||||
|
||||
if (!props.id) {
|
||||
return <As className={className} {...props} />
|
||||
}
|
||||
|
||||
const handleClick = async (e: React.MouseEvent) => {
|
||||
e.preventDefault()
|
||||
|
||||
const url = `${window.location.origin}${window.location.pathname}#${props.id}`
|
||||
|
||||
try {
|
||||
await navigator.clipboard.writeText(url)
|
||||
setCopied(true)
|
||||
|
||||
// Update URL hash without scrolling
|
||||
window.history.pushState(null, '', `#${props.id}`)
|
||||
|
||||
setTimeout(() => setCopied(false), 2000)
|
||||
} catch {
|
||||
// Fallback: just navigate to the anchor
|
||||
window.location.hash = props.id as string
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<As className={cn('group flex scroll-m-28 flex-row items-center gap-2', className)} {...props}>
|
||||
<a data-card='' href={`#${props.id}`} className='peer' onClick={handleClick}>
|
||||
{props.children}
|
||||
</a>
|
||||
{copied ? (
|
||||
<Check
|
||||
aria-hidden
|
||||
className='size-3.5 shrink-0 text-green-500 opacity-100 transition-opacity'
|
||||
/>
|
||||
) : (
|
||||
<Link
|
||||
aria-hidden
|
||||
className='size-3.5 shrink-0 text-fd-muted-foreground opacity-0 transition-opacity group-hover:opacity-100 peer-hover:opacity-100'
|
||||
/>
|
||||
)}
|
||||
</As>
|
||||
)
|
||||
}
|
||||
@@ -27,16 +27,14 @@ Alle API-Antworten enthalten Informationen über Ihre Workflow-Ausführungslimit
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60, // Sustained rate limit per minute
|
||||
"maxBurst": 120, // Maximum burst capacity
|
||||
"remaining": 118, // Current tokens available (up to maxBurst)
|
||||
"resetAt": "..." // When tokens next refill
|
||||
"limit": 60, // Max sync workflow executions per minute
|
||||
"remaining": 58, // Remaining sync workflow executions
|
||||
"resetAt": "..." // When the window resets
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200, // Sustained rate limit per minute
|
||||
"maxBurst": 400, // Maximum burst capacity
|
||||
"remaining": 398, // Current tokens available
|
||||
"resetAt": "..." // When tokens next refill
|
||||
"limit": 60, // Max async workflow executions per minute
|
||||
"remaining": 59, // Remaining async workflow executions
|
||||
"resetAt": "..." // When the window resets
|
||||
}
|
||||
},
|
||||
"usage": {
|
||||
@@ -48,7 +46,7 @@ Alle API-Antworten enthalten Informationen über Ihre Workflow-Ausführungslimit
|
||||
}
|
||||
```
|
||||
|
||||
**Hinweis:** Ratenbegrenzungen verwenden einen Token-Bucket-Algorithmus. `remaining` kann `requestsPerMinute` bis zu `maxBurst` überschreiten, wenn du dein volles Kontingent in letzter Zeit nicht genutzt hast, was Burst-Traffic ermöglicht. Die Ratenbegrenzungen im Antworttext gelten für Workflow-Ausführungen. Die Ratenbegrenzungen für den Aufruf dieses API-Endpunkts befinden sich in den Antwort-Headern (`X-RateLimit-*`).
|
||||
**Hinweis:** Die Ratenbegrenzungen in der Antwort beziehen sich auf Workflow-Ausführungen. Die Ratenbegrenzungen für den Aufruf dieses API-Endpunkts befinden sich in den Antwort-Headern (`X-RateLimit-*`).
|
||||
|
||||
### Logs abfragen
|
||||
|
||||
@@ -112,15 +110,13 @@ Fragen Sie Workflow-Ausführungsprotokolle mit umfangreichen Filteroptionen ab.
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60,
|
||||
"maxBurst": 120,
|
||||
"remaining": 118,
|
||||
"limit": 60,
|
||||
"remaining": 58,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 398,
|
||||
"limit": 60,
|
||||
"remaining": 59,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
}
|
||||
},
|
||||
@@ -194,15 +190,13 @@ Rufen Sie detaillierte Informationen zu einem bestimmten Logeintrag ab.
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60,
|
||||
"maxBurst": 120,
|
||||
"remaining": 118,
|
||||
"limit": 60,
|
||||
"remaining": 58,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 398,
|
||||
"limit": 60,
|
||||
"remaining": 59,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
}
|
||||
},
|
||||
@@ -488,27 +482,19 @@ Fehlgeschlagene Webhook-Zustellungen werden mit exponentiellem Backoff und Jitte
|
||||
|
||||
## Rate-Limiting
|
||||
|
||||
Die API verwendet einen **Token-Bucket-Algorithmus** für die Ratenbegrenzung, der eine faire Nutzung ermöglicht und gleichzeitig Burst-Traffic zulässt:
|
||||
Die API implementiert Rate-Limiting, um eine faire Nutzung zu gewährleisten:
|
||||
|
||||
| Plan | Anfragen/Minute | Burst-Kapazität |
|
||||
|------|-----------------|----------------|
|
||||
| Free | 10 | 20 |
|
||||
| Pro | 30 | 60 |
|
||||
| Team | 60 | 120 |
|
||||
| Enterprise | 120 | 240 |
|
||||
- **Kostenloser Plan**: 10 Anfragen pro Minute
|
||||
- **Pro-Plan**: 30 Anfragen pro Minute
|
||||
- **Team-Plan**: 60 Anfragen pro Minute
|
||||
- **Enterprise-Plan**: Individuelle Limits
|
||||
|
||||
**Wie es funktioniert:**
|
||||
- Tokens werden mit der Rate `requestsPerMinute` aufgefüllt
|
||||
- Du kannst im Leerlauf bis zu `maxBurst` Tokens ansammeln
|
||||
- Jede Anfrage verbraucht 1 Token
|
||||
- Die Burst-Kapazität ermöglicht die Bewältigung von Verkehrsspitzen
|
||||
Rate-Limit-Informationen sind in den Antwort-Headern enthalten:
|
||||
- `X-RateLimit-Limit`: Maximale Anfragen pro Zeitfenster
|
||||
- `X-RateLimit-Remaining`: Verbleibende Anfragen im aktuellen Zeitfenster
|
||||
- `X-RateLimit-Reset`: ISO-Zeitstempel, wann das Zeitfenster zurückgesetzt wird
|
||||
|
||||
Informationen zur Ratenbegrenzung sind in den Antwort-Headern enthalten:
|
||||
- `X-RateLimit-Limit`: Anfragen pro Minute (Auffüllrate)
|
||||
- `X-RateLimit-Remaining`: Aktuell verfügbare Tokens
|
||||
- `X-RateLimit-Reset`: ISO-Zeitstempel, wann Tokens als nächstes aufgefüllt werden
|
||||
|
||||
## Beispiel: Abfragen nach neuen Logs
|
||||
## Beispiel: Abfragen neuer Logs
|
||||
|
||||
```javascript
|
||||
let cursor = null;
|
||||
@@ -555,7 +541,7 @@ async function pollLogs() {
|
||||
setInterval(pollLogs, 30000);
|
||||
```
|
||||
|
||||
## Beispiel: Verarbeitung von Webhooks
|
||||
## Beispiel: Verarbeiten von Webhooks
|
||||
|
||||
```javascript
|
||||
import express from 'express';
|
||||
|
||||
@@ -147,20 +147,8 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
{
|
||||
"success": true,
|
||||
"rateLimit": {
|
||||
"sync": {
|
||||
"isLimited": false,
|
||||
"requestsPerMinute": 25,
|
||||
"maxBurst": 50,
|
||||
"remaining": 50,
|
||||
"resetAt": "2025-09-08T22:51:55.999Z"
|
||||
},
|
||||
"async": {
|
||||
"isLimited": false,
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 400,
|
||||
"resetAt": "2025-09-08T22:51:56.155Z"
|
||||
},
|
||||
"sync": { "isLimited": false, "limit": 10, "remaining": 10, "resetAt": "2025-09-08T22:51:55.999Z" },
|
||||
"async": { "isLimited": false, "limit": 50, "remaining": 50, "resetAt": "2025-09-08T22:51:56.155Z" },
|
||||
"authType": "api"
|
||||
},
|
||||
"usage": {
|
||||
@@ -171,54 +159,49 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
}
|
||||
```
|
||||
|
||||
**Rate-Limit-Felder:**
|
||||
- `requestsPerMinute`: Dauerhafte Rate-Begrenzung (Tokens werden mit dieser Rate aufgefüllt)
|
||||
- `maxBurst`: Maximale Tokens, die Sie ansammeln können (Burst-Kapazität)
|
||||
- `remaining`: Aktuell verfügbare Tokens (können bis zu `maxBurst` sein)
|
||||
|
||||
**Antwortfelder:**
|
||||
- `currentPeriodCost` spiegelt die Nutzung in der aktuellen Abrechnungsperiode wider
|
||||
- `limit` wird von individuellen Limits (Free/Pro) oder gepoolten Organisationslimits (Team/Enterprise) abgeleitet
|
||||
- `currentPeriodCost` zeigt die Nutzung im aktuellen Abrechnungszeitraum
|
||||
- `limit` wird aus individuellen Limits (Free/Pro) oder gebündelten Organisationslimits (Team/Enterprise) abgeleitet
|
||||
- `plan` ist der aktive Plan mit der höchsten Priorität, der mit Ihrem Benutzer verknüpft ist
|
||||
|
||||
## Plan-Limits
|
||||
|
||||
Verschiedene Abonnementpläne haben unterschiedliche Nutzungslimits:
|
||||
|
||||
| Plan | Monatliches Nutzungslimit | Rate-Limits (pro Minute) |
|
||||
| Plan | Monatliches Nutzungslimit | Ratengrenze (pro Minute) |
|
||||
|------|-------------------|-------------------------|
|
||||
| **Free** | $10 | 5 sync, 10 async |
|
||||
| **Pro** | $100 | 10 sync, 50 async |
|
||||
| **Team** | $500 (gepoolt) | 50 sync, 100 async |
|
||||
| **Team** | $500 (gebündelt) | 50 sync, 100 async |
|
||||
| **Enterprise** | Individuell | Individuell |
|
||||
|
||||
## Abrechnungsmodell
|
||||
|
||||
Sim verwendet ein **Basisabonnement + Mehrverbrauch**-Abrechnungsmodell:
|
||||
Sim verwendet ein **Basisabonnement + Überschreitung** Abrechnungsmodell:
|
||||
|
||||
### Wie es funktioniert
|
||||
|
||||
**Pro-Plan ($20/Monat):**
|
||||
**Pro Plan ($20/Monat):**
|
||||
- Monatliches Abonnement beinhaltet $20 Nutzung
|
||||
- Nutzung unter $20 → Keine zusätzlichen Kosten
|
||||
- Nutzung über $20 → Zahlen Sie den Mehrverbrauch am Monatsende
|
||||
- Beispiel: $35 Nutzung = $20 (Abonnement) + $15 (Mehrverbrauch)
|
||||
- Nutzung über $20 → Zahlung der Überschreitung am Monatsende
|
||||
- Beispiel: $35 Nutzung = $20 (Abonnement) + $15 (Überschreitung)
|
||||
|
||||
**Team-Plan ($40/Benutzer/Monat):**
|
||||
- Gepoolte Nutzung für alle Teammitglieder
|
||||
- Mehrverbrauch wird aus der Gesamtnutzung des Teams berechnet
|
||||
**Team Plan ($40/Benutzer/Monat):**
|
||||
- Gebündelte Nutzung für alle Teammitglieder
|
||||
- Überschreitung wird aus der Gesamtnutzung des Teams berechnet
|
||||
- Organisationsinhaber erhält eine Rechnung
|
||||
|
||||
**Enterprise-Pläne:**
|
||||
- Fester monatlicher Preis, kein Mehrverbrauch
|
||||
**Enterprise Pläne:**
|
||||
- Fester monatlicher Preis, keine Überschreitungen
|
||||
- Individuelle Nutzungslimits gemäß Vereinbarung
|
||||
|
||||
### Schwellenwert-Abrechnung
|
||||
### Schwellenwertabrechnung
|
||||
|
||||
Wenn der nicht abgerechnete Mehrverbrauch $50 erreicht, berechnet Sim automatisch den gesamten nicht abgerechneten Betrag.
|
||||
Wenn die nicht abgerechnete Überschreitung $50 erreicht, berechnet Sim automatisch den gesamten nicht abgerechneten Betrag.
|
||||
|
||||
**Beispiel:**
|
||||
- Tag 10: $70 Mehrverbrauch → Sofortige Abrechnung von $70
|
||||
- Tag 10: $70 Überschreitung → Sofortige Abrechnung von $70
|
||||
- Tag 15: Zusätzliche $35 Nutzung ($105 insgesamt) → Bereits abgerechnet, keine Aktion
|
||||
- Tag 20: Weitere $50 Nutzung ($155 insgesamt, $85 nicht abgerechnet) → Sofortige Abrechnung von $85
|
||||
|
||||
|
||||
@@ -46,11 +46,11 @@ Durchsuchen Sie das Web mit Exa AI. Liefert relevante Suchergebnisse mit Titeln,
|
||||
| `type` | string | Nein | Suchtyp: neural, keyword, auto oder fast \(Standard: auto\) |
|
||||
| `includeDomains` | string | Nein | Kommagetrennte Liste von Domains, die in den Ergebnissen enthalten sein sollen |
|
||||
| `excludeDomains` | string | Nein | Kommagetrennte Liste von Domains, die aus den Ergebnissen ausgeschlossen werden sollen |
|
||||
| `category` | string | Nein | Nach Kategorie filtern: company, research paper, news, pdf, github, tweet, personal site, linkedin profile, financial report |
|
||||
| `category` | string | Nein | Nach Kategorie filtern: company, research_paper, news_article, pdf, github, tweet, movie, song, personal_site |
|
||||
| `text` | boolean | Nein | Vollständigen Textinhalt in Ergebnissen einschließen \(Standard: false\) |
|
||||
| `highlights` | boolean | Nein | Hervorgehobene Ausschnitte in Ergebnissen einschließen \(Standard: false\) |
|
||||
| `summary` | boolean | Nein | KI-generierte Zusammenfassungen in Ergebnissen einschließen \(Standard: false\) |
|
||||
| `livecrawl` | string | Nein | Live-Crawling-Modus: never \(Standard\), fallback, always oder preferred \(immer livecrawl versuchen, bei Fehlschlag auf Cache zurückgreifen\) |
|
||||
| `livecrawl` | string | Nein | Live-Crawling-Modus: always, fallback oder never \(Standard: never\) |
|
||||
| `apiKey` | string | Ja | Exa AI API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
@@ -69,11 +69,11 @@ Ruft den Inhalt von Webseiten mit Exa AI ab. Gibt den Titel, Textinhalt und opti
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `urls` | string | Ja | Kommagetrennte Liste von URLs, von denen Inhalte abgerufen werden sollen |
|
||||
| `text` | boolean | Nein | Wenn true, gibt den vollständigen Seitentext mit Standardeinstellungen zurück. Wenn false, deaktiviert die Textrückgabe. |
|
||||
| `summaryQuery` | string | Nein | Anfrage zur Steuerung der Zusammenfassungserstellung |
|
||||
| `subpages` | number | Nein | Anzahl der Unterseiten, die von den bereitgestellten URLs gecrawlt werden sollen |
|
||||
| `summaryQuery` | string | Nein | Abfrage zur Steuerung der Zusammenfassungserstellung |
|
||||
| `subpages` | number | Nein | Anzahl der Unterseiten, die von den angegebenen URLs gecrawlt werden sollen |
|
||||
| `subpageTarget` | string | Nein | Kommagetrennte Schlüsselwörter zur Zielausrichtung auf bestimmte Unterseiten \(z.B. "docs,tutorial,about"\) |
|
||||
| `highlights` | boolean | Nein | Hervorgehobene Ausschnitte in Ergebnissen einschließen \(Standard: false\) |
|
||||
| `livecrawl` | string | Nein | Live-Crawling-Modus: never \(Standard\), fallback, always oder preferred \(immer livecrawl versuchen, bei Fehlschlag auf Cache zurückgreifen\) |
|
||||
| `livecrawl` | string | Nein | Live-Crawling-Modus: always, fallback oder never \(Standard: never\) |
|
||||
| `apiKey` | string | Ja | Exa AI API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
@@ -95,10 +95,11 @@ Finde Webseiten, die einer bestimmten URL ähnlich sind, mit Exa AI. Gibt eine L
|
||||
| `text` | boolean | Nein | Ob der vollständige Text der ähnlichen Seiten eingeschlossen werden soll |
|
||||
| `includeDomains` | string | Nein | Kommagetrennte Liste von Domains, die in den Ergebnissen enthalten sein sollen |
|
||||
| `excludeDomains` | string | Nein | Kommagetrennte Liste von Domains, die aus den Ergebnissen ausgeschlossen werden sollen |
|
||||
| `excludeSourceDomain` | boolean | Nein | Die Quell-Domain aus den Ergebnissen ausschließen \(Standard: false\) |
|
||||
| `excludeSourceDomain` | boolean | Nein | Quell-Domain aus Ergebnissen ausschließen \(Standard: false\) |
|
||||
| `category` | string | Nein | Nach Kategorie filtern: company, research_paper, news_article, pdf, github, tweet, movie, song, personal_site |
|
||||
| `highlights` | boolean | Nein | Hervorgehobene Ausschnitte in Ergebnissen einschließen \(Standard: false\) |
|
||||
| `summary` | boolean | Nein | KI-generierte Zusammenfassungen in Ergebnissen einschließen \(Standard: false\) |
|
||||
| `livecrawl` | string | Nein | Live-Crawling-Modus: never \(Standard\), fallback, always oder preferred \(versucht immer livecrawl, fällt auf Cache zurück, wenn es fehlschlägt\) |
|
||||
| `livecrawl` | string | Nein | Live-Crawling-Modus: always, fallback oder never \(Standard: never\) |
|
||||
| `apiKey` | string | Ja | Exa AI API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
@@ -49,8 +49,8 @@ Rufe eine Liste von Prognosemärkten von Kalshi mit optionaler Filterung ab
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `markets` | array | Array von Markt-Objekten |
|
||||
| `paging` | object | Paginierungscursor zum Abrufen weiterer Ergebnisse |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Marktdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_market`
|
||||
|
||||
@@ -66,7 +66,8 @@ Rufe Details eines bestimmten Prognosemarkts nach Ticker ab
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `market` | object | Markt-Objekt mit Details |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Marktdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_events`
|
||||
|
||||
@@ -84,10 +85,10 @@ Rufe eine Liste von Events von Kalshi mit optionaler Filterung ab
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `events` | array | Array von Ereignis-Objekten |
|
||||
| `paging` | object | Paginierungscursor zum Abrufen weiterer Ergebnisse |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Ereignisdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_event`
|
||||
|
||||
@@ -102,9 +103,10 @@ Details eines bestimmten Ereignisses anhand des Tickers abrufen
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | Ereignis-Objekt mit Details |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Ereignisdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_balance`
|
||||
|
||||
@@ -119,12 +121,10 @@ Kontostand und Portfoliowert von Kalshi abrufen
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `balance` | number | Kontostand in Cent |
|
||||
| `portfolioValue` | number | Portfoliowert in Cent |
|
||||
| `balanceDollars` | number | Kontostand in Dollar |
|
||||
| `portfolioValueDollars` | number | Portfoliowert in Dollar |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Kontostandsdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_positions`
|
||||
|
||||
@@ -146,8 +146,8 @@ Offene Positionen von Kalshi abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `positions` | array | Array von Positions-Objekten |
|
||||
| `paging` | object | Paginierungscursor zum Abrufen weiterer Ergebnisse |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Positionsdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_orders`
|
||||
|
||||
@@ -169,8 +169,8 @@ Rufen Sie Ihre Bestellungen von Kalshi mit optionaler Filterung ab
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orders` | array | Array von Auftrags-Objekten |
|
||||
| `paging` | object | Paginierungscursor zum Abrufen weiterer Ergebnisse |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Bestelldaten und Metadaten |
|
||||
|
||||
### `kalshi_get_order`
|
||||
|
||||
@@ -188,7 +188,8 @@ Rufen Sie Details zu einem bestimmten Auftrag anhand der ID von Kalshi ab
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | Auftrags-Objekt mit Details |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Auftragsdaten |
|
||||
|
||||
### `kalshi_get_orderbook`
|
||||
|
||||
@@ -204,7 +205,8 @@ Rufen Sie das Orderbuch (Ja- und Nein-Gebote) für einen bestimmten Markt ab
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orderbook` | object | Orderbuch mit Ja/Nein-Geboten und -Anfragen |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Orderbuch-Daten und Metadaten |
|
||||
|
||||
### `kalshi_get_trades`
|
||||
|
||||
@@ -221,8 +223,8 @@ Rufen Sie aktuelle Trades über alle Märkte hinweg ab
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | array | Array von Handelsobjekten |
|
||||
| `paging` | object | Paginierungscursor zum Abrufen weiterer Ergebnisse |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Handelsdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_candlesticks`
|
||||
|
||||
@@ -242,7 +244,8 @@ OHLC-Kerzendaten für einen bestimmten Markt abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `candlesticks` | array | Array von OHLC-Kerzendaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Kerzendaten und Metadaten |
|
||||
|
||||
### `kalshi_get_fills`
|
||||
|
||||
@@ -265,8 +268,8 @@ Ihr Portfolio abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `fills` | array | Array von Ausführungs-/Handelsobjekten |
|
||||
| `paging` | object | Paginierungscursor zum Abrufen weiterer Ergebnisse |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Ausführungsdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_series_by_ticker`
|
||||
|
||||
@@ -282,7 +285,8 @@ Details einer bestimmten Marktserie nach Ticker abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | object | Serienobjekt mit Details |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Seriendaten und Metadaten |
|
||||
|
||||
### `kalshi_get_exchange_status`
|
||||
|
||||
@@ -297,7 +301,8 @@ Den aktuellen Status der Kalshi-Börse abrufen (Handel und Börsenaktivität)
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | object | Börsenstatus mit trading_active und exchange_active Flags |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Börsenstatus-Daten und Metadaten |
|
||||
|
||||
### `kalshi_create_order`
|
||||
|
||||
@@ -331,7 +336,8 @@ Eine neue Order auf einem Kalshi-Prognosemarkt erstellen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | Das erstellte Auftragsobjekt |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Erstellte Auftragsdaten |
|
||||
|
||||
### `kalshi_cancel_order`
|
||||
|
||||
@@ -349,8 +355,8 @@ Einen bestehenden Auftrag auf Kalshi stornieren
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | Das stornierte Auftragsobjekt |
|
||||
| `reducedBy` | number | Anzahl der stornierten Kontrakte |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Stornierte Auftragsdaten |
|
||||
|
||||
### `kalshi_amend_order`
|
||||
|
||||
@@ -378,7 +384,8 @@ Preis oder Menge eines bestehenden Auftrags auf Kalshi ändern
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | Das geänderte Auftragsobjekt |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Geänderte Auftragsdaten |
|
||||
|
||||
## Hinweise
|
||||
|
||||
|
||||
@@ -91,11 +91,11 @@ Führen Sie umfassende tiefgehende Recherchen im Web mit Parallel AI durch. Synt
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Aufgabenstatus (abgeschlossen, fehlgeschlagen) |
|
||||
| `status` | string | Aufgabenstatus (laufend, abgeschlossen, fehlgeschlagen) |
|
||||
| `run_id` | string | Eindeutige ID für diese Rechercheaufgabe |
|
||||
| `message` | string | Statusmeldung |
|
||||
| `message` | string | Statusmeldung (für laufende Aufgaben) |
|
||||
| `content` | object | Rechercheergebnisse (strukturiert basierend auf output_schema) |
|
||||
| `basis` | array | Zitate und Quellen mit Begründung und Vertrauensstufen |
|
||||
| `basis` | array | Zitate und Quellen mit Auszügen und Vertrauensstufen |
|
||||
|
||||
## Hinweise
|
||||
|
||||
|
||||
@@ -51,9 +51,8 @@ Generieren Sie Vervollständigungen mit Perplexity AI-Chatmodellen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | Generierter Textinhalt |
|
||||
| `model` | string | Für die Generierung verwendetes Modell |
|
||||
| `usage` | object | Informationen zur Token-Nutzung |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Ergebnisse der Chat-Vervollständigung |
|
||||
|
||||
### `perplexity_search`
|
||||
|
||||
@@ -77,7 +76,8 @@ Erhalte bewertete Suchergebnisse von Perplexity
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Array von Suchergebnissen |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Suchergebnisse |
|
||||
|
||||
## Hinweise
|
||||
|
||||
|
||||
@@ -44,14 +44,14 @@ Rufen Sie eine Liste von Prognosemärkten von Polymarket mit optionaler Filterun
|
||||
| `order` | string | Nein | Sortierfeld \(z.B. volumeNum, liquidityNum, startDate, endDate, createdAt\) |
|
||||
| `ascending` | string | Nein | Sortierrichtung \(true für aufsteigend, false für absteigend\) |
|
||||
| `tagId` | string | Nein | Nach Tag-ID filtern |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(max 50\) |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(empfohlen: 25-50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe diese Anzahl an Ergebnissen\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Marktdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_market`
|
||||
@@ -80,11 +80,11 @@ Ruft eine Liste von Events von Polymarket mit optionaler Filterung ab
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `closed` | string | Nein | Nach geschlossenem Status filtern \(true/false\). Verwenden Sie false für nur aktive Ereignisse. |
|
||||
| `closed` | string | Nein | Nach geschlossenem Status filtern \(true/false\). Verwenden Sie false für nur aktive Events. |
|
||||
| `order` | string | Nein | Sortierfeld \(z.B. volume, liquidity, startDate, endDate, createdAt\) |
|
||||
| `ascending` | string | Nein | Sortierrichtung \(true für aufsteigend, false für absteigend\) |
|
||||
| `tagId` | string | Nein | Nach Tag-ID filtern |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(max 50\) |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(empfohlen: 25-50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe diese Anzahl an Ergebnissen\) |
|
||||
|
||||
#### Ausgabe
|
||||
@@ -107,10 +107,10 @@ Ruft Details eines bestimmten Events nach ID oder Slug ab
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Event-Daten und Metadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Ereignisdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_tags`
|
||||
|
||||
@@ -118,16 +118,16 @@ Verfügbare Tags zum Filtern von Märkten von Polymarket abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(max 50\) |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(empfohlen: 25-50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe diese Anzahl an Ergebnissen\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Tag-Daten und Metadaten |
|
||||
|
||||
### `polymarket_search`
|
||||
@@ -136,17 +136,17 @@ Nach Märkten, Ereignissen und Profilen auf Polymarket suchen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Ja | Suchbegriff |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(max 50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(empfohlen: 25-50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe diese Anzahl an Ergebnissen\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Suchergebnisse und Metadaten |
|
||||
|
||||
### `polymarket_get_series`
|
||||
@@ -155,16 +155,17 @@ Serien (verwandte Marktgruppen) von Polymarket abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(max 50\) |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(empfohlen: 25-50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe diese Anzahl an Ergebnissen\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | array | Array von Serien-Objekten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Seriendaten und Metadaten |
|
||||
|
||||
### `polymarket_get_series_by_id`
|
||||
|
||||
@@ -178,9 +179,10 @@ Eine bestimmte Serie (zugehörige Marktgruppe) anhand der ID von Polymarket abru
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | object | Serien-Objekt mit Details |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Seriendaten und Metadaten |
|
||||
|
||||
### `polymarket_get_orderbook`
|
||||
|
||||
@@ -194,9 +196,10 @@ Die Orderbuch-Zusammenfassung für einen bestimmten Token abrufen
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orderbook` | object | Orderbuch mit Geld- und Briefkurs-Arrays |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Orderbuch-Daten und Metadaten |
|
||||
|
||||
### `polymarket_get_price`
|
||||
|
||||
@@ -213,7 +216,8 @@ Den Marktpreis für einen bestimmten Token und eine bestimmte Seite abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `price` | string | Marktpreis |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Preisdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_midpoint`
|
||||
|
||||
@@ -229,7 +233,8 @@ Abrufen des Mittelpreises für einen bestimmten Token
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `midpoint` | string | Mittelkurs |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Mittelpreisdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_price_history`
|
||||
|
||||
@@ -249,7 +254,8 @@ Abrufen historischer Preisdaten für einen bestimmten Markttoken
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `history` | array | Array von Preisverlaufseinträgen mit Zeitstempel \(t\) und Preis \(p\) |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Preisverlaufsdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_last_trade_price`
|
||||
|
||||
@@ -265,7 +271,8 @@ Den letzten Handelspreis für einen bestimmten Token abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `price` | string | Letzter Handelspreis |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Letzter Handelspreis und Metadaten |
|
||||
|
||||
### `polymarket_get_spread`
|
||||
|
||||
@@ -281,7 +288,8 @@ Die Geld-Brief-Spanne für einen bestimmten Token abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `spread` | object | Geld-Brief-Spanne mit Geld- und Briefkursen |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Spread-Daten und Metadaten |
|
||||
|
||||
### `polymarket_get_tick_size`
|
||||
|
||||
@@ -297,7 +305,8 @@ Die minimale Tickgröße für einen bestimmten Token abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tickSize` | string | Minimale Tick-Größe |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Tickgröße und Metadaten |
|
||||
|
||||
### `polymarket_get_positions`
|
||||
|
||||
@@ -314,7 +323,8 @@ Benutzerpositionen von Polymarket abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `positions` | array | Array von Positions-Objekten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Positionsdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_trades`
|
||||
|
||||
@@ -326,14 +336,15 @@ Handelshistorie von Polymarket abrufen
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `user` | string | Nein | Wallet-Adresse des Benutzers zum Filtern von Trades |
|
||||
| `market` | string | Nein | Markt-ID zum Filtern von Trades |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(max 50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe diese Anzahl an Ergebnissen\) |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(empfohlen: 25-50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe so viele Ergebnisse\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | array | Array von Handelsobjekten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Handelsdaten und Metadaten |
|
||||
|
||||
## Hinweise
|
||||
|
||||
|
||||
@@ -342,30 +342,19 @@ Eine E-Mail-Vorlage von SendGrid löschen
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `message` | string | Status- oder Erfolgsmeldung |
|
||||
| `messageId` | string | E-Mail-Nachrichten-ID \(send_mail\) |
|
||||
| `to` | string | E-Mail-Adresse des Empfängers \(send_mail\) |
|
||||
| `subject` | string | E-Mail-Betreff \(send_mail, create_template_version\) |
|
||||
| `messageId` | string | E-Mail-Nachrichten-ID (send_mail) |
|
||||
| `id` | string | Ressourcen-ID |
|
||||
| `jobId` | string | Job-ID für asynchrone Operationen |
|
||||
| `email` | string | E-Mail-Adresse des Kontakts |
|
||||
| `firstName` | string | Vorname des Kontakts |
|
||||
| `lastName` | string | Nachname des Kontakts |
|
||||
| `createdAt` | string | Erstellungszeitstempel |
|
||||
| `updatedAt` | string | Zeitstempel der letzten Aktualisierung |
|
||||
| `listIds` | json | Array von Listen-IDs, zu denen der Kontakt gehört |
|
||||
| `customFields` | json | Benutzerdefinierte Feldwerte |
|
||||
| `email` | string | E-Mail-Adresse |
|
||||
| `firstName` | string | Vorname |
|
||||
| `lastName` | string | Nachname |
|
||||
| `contacts` | json | Array von Kontakten |
|
||||
| `contactCount` | number | Anzahl der Kontakte |
|
||||
| `lists` | json | Array von Listen |
|
||||
| `name` | string | Ressourcenname |
|
||||
| `templates` | json | Array von Vorlagen |
|
||||
| `message` | string | Status- oder Erfolgsmeldung |
|
||||
| `name` | string | Ressourcenname |
|
||||
| `generation` | string | Vorlagengeneration |
|
||||
| `versions` | json | Array von Vorlagenversionen |
|
||||
| `templateId` | string | Vorlagen-ID |
|
||||
| `active` | boolean | Ob die Vorlagenversion aktiv ist |
|
||||
| `htmlContent` | string | HTML-Inhalt |
|
||||
| `plainContent` | string | Nur-Text-Inhalt |
|
||||
|
||||
### `sendgrid_create_template_version`
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ Verarbeitet einen bereitgestellten Gedanken/eine Anweisung und macht ihn für na
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `thought` | string | Ja | Ihre interne Argumentation, Analyse oder Denkprozess. Nutzen Sie dies, um das Problem Schritt für Schritt zu durchdenken, bevor Sie antworten. |
|
||||
| `thought` | string | Ja | Der vom Benutzer im Thinking Step-Block bereitgestellte Denkprozess oder die Anweisung. |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -31,32 +31,39 @@ Integrieren Sie Übersetzen in den Workflow. Kann Text in jede Sprache übersetz
|
||||
|
||||
## Tools
|
||||
|
||||
### `llm_chat`
|
||||
|
||||
Senden Sie eine Chat-Completion-Anfrage an jeden unterstützten LLM-Anbieter
|
||||
### `openai_chat`
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `model` | string | Ja | Das zu verwendende Modell (z.B. gpt-4o, claude-sonnet-4-5, gemini-2.0-flash) |
|
||||
| `systemPrompt` | string | Nein | System-Prompt zur Festlegung des Assistentenverhaltens |
|
||||
| `context` | string | Ja | Die Benutzernachricht oder der Kontext, der an das Modell gesendet wird |
|
||||
| `apiKey` | string | Nein | API-Schlüssel für den Anbieter (verwendet den Plattformschlüssel, wenn für gehostete Modelle nicht angegeben) |
|
||||
| `temperature` | number | Nein | Temperatur für die Antwortgenerierung (0-2) |
|
||||
| `maxTokens` | number | Nein | Maximale Tokens in der Antwort |
|
||||
| `azureEndpoint` | string | Nein | Azure OpenAI-Endpunkt-URL |
|
||||
| `azureApiVersion` | string | Nein | Azure OpenAI API-Version |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | Der generierte Antwortinhalt |
|
||||
| `model` | string | Das für die Generierung verwendete Modell |
|
||||
| `tokens` | object | Informationen zur Token-Nutzung |
|
||||
| `content` | string | Übersetzter Text |
|
||||
| `model` | string | Verwendetes Modell |
|
||||
| `tokens` | json | Token-Nutzung |
|
||||
|
||||
## Hinweise
|
||||
### `anthropic_chat`
|
||||
|
||||
### `google_chat`
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | Übersetzter Text |
|
||||
| `model` | string | Verwendetes Modell |
|
||||
| `tokens` | json | Token-Nutzung |
|
||||
|
||||
## Notizen
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `translate`
|
||||
|
||||
@@ -250,9 +250,9 @@ Eine Mediendatei (Bild, Video, Dokument) zu WordPress.com hochladen
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `file` | file | Nein | Hochzuladende Datei \(UserFile-Objekt\) |
|
||||
| `filename` | string | Nein | Optionale Überschreibung des Dateinamens \(z.B. bild.jpg\) |
|
||||
| `siteId` | string | Ja | WordPress.com-Website-ID oder Domain \(z.B. 12345678 oder meinwebsite.wordpress.com\) |
|
||||
| `file` | string | Ja | Base64-kodierte Dateidaten oder URL, von der die Datei abgerufen werden soll |
|
||||
| `filename` | string | Ja | Dateiname mit Erweiterung \(z.B. bild.jpg\) |
|
||||
| `title` | string | Nein | Medientitel |
|
||||
| `caption` | string | Nein | Medienunterschrift |
|
||||
| `altText` | string | Nein | Alternativer Text für Barrierefreiheit |
|
||||
|
||||
@@ -170,9 +170,28 @@ Videos aus einer YouTube-Playlist abrufen.
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array von Videos in der Playlist |
|
||||
|
||||
### `youtube_related_videos`
|
||||
|
||||
Finde Videos, die mit einem bestimmten YouTube-Video verwandt sind.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `videoId` | string | Ja | YouTube-Video-ID, für die verwandte Videos gefunden werden sollen |
|
||||
| `maxResults` | number | Nein | Maximale Anzahl der zurückzugebenden verwandten Videos \(1-50\) |
|
||||
| `pageToken` | string | Nein | Page-Token für Paginierung |
|
||||
| `apiKey` | string | Ja | YouTube API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array von verwandten Videos |
|
||||
|
||||
### `youtube_comments`
|
||||
|
||||
Kommentare von einem YouTube-Video abrufen.
|
||||
Rufe Kommentare von einem YouTube-Video ab.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
@@ -181,7 +200,7 @@ Kommentare von einem YouTube-Video abrufen.
|
||||
| `videoId` | string | Ja | YouTube-Video-ID |
|
||||
| `maxResults` | number | Nein | Maximale Anzahl der zurückzugebenden Kommentare |
|
||||
| `order` | string | Nein | Reihenfolge der Kommentare: time oder relevance |
|
||||
| `pageToken` | string | Nein | Seitentoken für Paginierung |
|
||||
| `pageToken` | string | Nein | Page-Token für Paginierung |
|
||||
| `apiKey` | string | Ja | YouTube API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
@@ -73,9 +73,8 @@ Eine Liste von Tickets aus Zendesk mit optionaler Filterung abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tickets` | array | Array von Ticket-Objekten |
|
||||
| `paging` | object | Paginierungsinformationen |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Ticket-Daten und Metadaten |
|
||||
|
||||
### `zendesk_get_ticket`
|
||||
|
||||
@@ -94,8 +93,8 @@ Ein einzelnes Ticket anhand der ID von Zendesk abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Ticket-Objekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Ticket-Daten |
|
||||
|
||||
### `zendesk_create_ticket`
|
||||
|
||||
@@ -121,10 +120,10 @@ Ein neues Ticket in Zendesk erstellen mit Unterstützung für benutzerdefinierte
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Erstelltes Ticket-Objekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Erstellte Ticket-Daten |
|
||||
|
||||
### `zendesk_create_tickets_bulk`
|
||||
|
||||
@@ -141,10 +140,10 @@ Erstellen Sie mehrere Tickets in Zendesk auf einmal (maximal 100)
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Job-Status-Objekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Status des Massenerstell-Jobs |
|
||||
|
||||
### `zendesk_update_ticket`
|
||||
|
||||
@@ -172,8 +171,8 @@ Aktualisieren Sie ein bestehendes Ticket in Zendesk mit Unterstützung für benu
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Aktualisiertes Ticket-Objekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Aktualisierte Ticket-Daten |
|
||||
|
||||
### `zendesk_update_tickets_bulk`
|
||||
|
||||
@@ -197,8 +196,8 @@ Mehrere Tickets in Zendesk auf einmal aktualisieren (max. 100)
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Job-Status-Objekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Status des Massenaktualisierungsauftrags |
|
||||
|
||||
### `zendesk_delete_ticket`
|
||||
|
||||
@@ -217,8 +216,8 @@ Ein Ticket aus Zendesk löschen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Löschvorgang erfolgreich |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Löschbestätigung |
|
||||
|
||||
### `zendesk_merge_tickets`
|
||||
|
||||
@@ -239,8 +238,8 @@ Mehrere Tickets in ein Zielticket zusammenführen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Job-Status-Objekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Status des Zusammenführungsauftrags |
|
||||
|
||||
### `zendesk_get_users`
|
||||
|
||||
@@ -262,9 +261,8 @@ Eine Liste von Benutzern aus Zendesk mit optionaler Filterung abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Array von Benutzerobjekten |
|
||||
| `paging` | object | Paginierungsinformationen |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Benutzerdaten und Metadaten |
|
||||
|
||||
### `zendesk_get_user`
|
||||
|
||||
@@ -283,8 +281,8 @@ Einen einzelnen Benutzer anhand der ID von Zendesk abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Benutzerobjekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Benutzerdaten |
|
||||
|
||||
### `zendesk_get_current_user`
|
||||
|
||||
@@ -302,8 +300,8 @@ Den aktuell authentifizierten Benutzer von Zendesk abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Aktuelles Benutzerobjekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Daten des aktuellen Benutzers |
|
||||
|
||||
### `zendesk_search_users`
|
||||
|
||||
@@ -325,9 +323,8 @@ Nach Benutzern in Zendesk mit einer Abfragezeichenfolge suchen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Array von Benutzerobjekten |
|
||||
| `paging` | object | Paginierungsinformationen |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Suchergebnisse für Benutzer |
|
||||
|
||||
### `zendesk_create_user`
|
||||
|
||||
@@ -351,10 +348,10 @@ Einen neuen Benutzer in Zendesk erstellen
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Erstelltes Benutzerobjekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Erstellte Benutzerdaten |
|
||||
|
||||
### `zendesk_create_users_bulk`
|
||||
|
||||
@@ -371,10 +368,10 @@ Erstellen mehrerer Benutzer in Zendesk mittels Massenimport
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Job-Statusobjekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Status des Massenimport-Jobs |
|
||||
|
||||
### `zendesk_update_user`
|
||||
|
||||
@@ -401,8 +398,8 @@ Aktualisieren eines vorhandenen Benutzers in Zendesk
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Aktualisiertes Benutzerobjekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Aktualisierte Benutzerdaten |
|
||||
|
||||
### `zendesk_update_users_bulk`
|
||||
|
||||
@@ -421,8 +418,8 @@ Mehrere Benutzer in Zendesk über Massenaktualisierung aktualisieren
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Job-Statusobjekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Status des Massenaktualisierungsauftrags |
|
||||
|
||||
### `zendesk_delete_user`
|
||||
|
||||
@@ -441,8 +438,8 @@ Einen Benutzer aus Zendesk löschen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Löscherfolg |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Daten des gelöschten Benutzers |
|
||||
|
||||
### `zendesk_get_organizations`
|
||||
|
||||
@@ -462,9 +459,8 @@ Eine Liste von Organisationen von Zendesk abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | Array von Organisationsobjekten |
|
||||
| `paging` | object | Paginierungsinformationen |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Organisationsdaten und Metadaten |
|
||||
|
||||
### `zendesk_get_organization`
|
||||
|
||||
@@ -483,8 +479,8 @@ Eine einzelne Organisation anhand der ID von Zendesk abrufen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | Organisationsobjekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Organisationsdaten |
|
||||
|
||||
### `zendesk_autocomplete_organizations`
|
||||
|
||||
@@ -503,11 +499,10 @@ Autovervollständigung von Organisationen in Zendesk nach Namenspräfix (für Na
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | Array von Organisationsobjekten |
|
||||
| `paging` | object | Paginierungsinformationen |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Suchergebnisse für Organisationen |
|
||||
|
||||
### `zendesk_create_organization`
|
||||
|
||||
@@ -529,10 +524,10 @@ Eine neue Organisation in Zendesk erstellen
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | Erstelltes Organisationsobjekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Daten der erstellten Organisation |
|
||||
|
||||
### `zendesk_create_organizations_bulk`
|
||||
|
||||
@@ -551,8 +546,8 @@ Mehrere Organisationen in Zendesk über Massenimport erstellen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Job-Statusobjekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Status des Massenerfassungsauftrags |
|
||||
|
||||
### `zendesk_update_organization`
|
||||
|
||||
@@ -577,8 +572,8 @@ Eine bestehende Organisation in Zendesk aktualisieren
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | Aktualisiertes Organisationsobjekt |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Aktualisierte Organisationsdaten |
|
||||
|
||||
### `zendesk_delete_organization`
|
||||
|
||||
@@ -597,8 +592,8 @@ Eine Organisation aus Zendesk löschen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Löscherfolg |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Gelöschte Organisationsdaten |
|
||||
|
||||
### `zendesk_search`
|
||||
|
||||
@@ -621,9 +616,8 @@ Einheitliche Suche über Tickets, Benutzer und Organisationen in Zendesk
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Array von Ergebnisobjekten |
|
||||
| `paging` | object | Paginierungsinformationen |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Suchergebnisse |
|
||||
|
||||
### `zendesk_search_count`
|
||||
|
||||
@@ -642,8 +636,8 @@ Zählen der Anzahl von Suchergebnissen, die einer Abfrage in Zendesk entsprechen
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `count` | number | Anzahl der übereinstimmenden Ergebnisse |
|
||||
| `metadata` | object | Operationsmetadaten |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Suchergebnis-Anzahl |
|
||||
|
||||
## Hinweise
|
||||
|
||||
|
||||
@@ -30,19 +30,15 @@ Verwende den Start-Block für alles, was aus dem Editor, deploy-to-API oder depl
|
||||
<Card title="Schedule" href="/triggers/schedule">
|
||||
Cron- oder intervallbasierte Ausführung
|
||||
</Card>
|
||||
<Card title="RSS Feed" href="/triggers/rss">
|
||||
RSS- und Atom-Feeds auf neue Inhalte überwachen
|
||||
</Card>
|
||||
</Cards>
|
||||
|
||||
## Schneller Vergleich
|
||||
|
||||
| Trigger | Startbedingung |
|
||||
|---------|-----------------|
|
||||
| **Start** | Editor-Ausführungen, Deploy-to-API-Anfragen oder Chat-Nachrichten |
|
||||
| **Start** | Editor-Ausführungen, deploy-to-API Anfragen oder Chat-Nachrichten |
|
||||
| **Schedule** | Timer, der im Schedule-Block verwaltet wird |
|
||||
| **Webhook** | Bei eingehender HTTP-Anfrage |
|
||||
| **RSS Feed** | Neues Element im Feed veröffentlicht |
|
||||
|
||||
> Der Start-Block stellt immer `input`, `conversationId` und `files` Felder bereit. Füge benutzerdefinierte Felder zum Eingabeformat für zusätzliche strukturierte Daten hinzu.
|
||||
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
title: RSS-Feed
|
||||
---
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { Image } from '@/components/ui/image'
|
||||
|
||||
Der RSS-Feed-Block überwacht RSS- und Atom-Feeds – wenn neue Einträge veröffentlicht werden, wird Ihr Workflow automatisch ausgelöst.
|
||||
|
||||
<div className="flex justify-center">
|
||||
<Image
|
||||
src="/static/blocks/rss.png"
|
||||
alt="RSS-Feed-Block"
|
||||
width={500}
|
||||
height={400}
|
||||
className="my-6"
|
||||
/>
|
||||
</div>
|
||||
|
||||
## Konfiguration
|
||||
|
||||
1. **RSS-Feed-Block hinzufügen** - Ziehen Sie den RSS-Feed-Block, um Ihren Workflow zu starten
|
||||
2. **Feed-URL eingeben** - Fügen Sie die URL eines beliebigen RSS- oder Atom-Feeds ein
|
||||
3. **Bereitstellen** - Stellen Sie Ihren Workflow bereit, um das Polling zu aktivieren
|
||||
|
||||
Nach der Bereitstellung wird der Feed jede Minute auf neue Einträge überprüft.
|
||||
|
||||
## Ausgabefelder
|
||||
|
||||
| Feld | Typ | Beschreibung |
|
||||
|-------|------|-------------|
|
||||
| `title` | string | Titel des Eintrags |
|
||||
| `link` | string | Link des Eintrags |
|
||||
| `pubDate` | string | Veröffentlichungsdatum |
|
||||
| `item` | object | Rohdaten des Eintrags mit allen Feldern |
|
||||
| `feed` | object | Rohdaten der Feed-Metadaten |
|
||||
|
||||
Greifen Sie direkt auf zugeordnete Felder zu (`<rss.title>`) oder verwenden Sie die Rohobjekte für beliebige Felder (`<rss.item.author>`, `<rss.feed.language>`).
|
||||
|
||||
## Anwendungsfälle
|
||||
|
||||
- **Inhaltsüberwachung** - Verfolgen Sie Blogs, Nachrichtenseiten oder Updates von Wettbewerbern
|
||||
- **Podcast-Automatisierung** - Lösen Sie Workflows aus, wenn neue Episoden erscheinen
|
||||
- **Release-Tracking** - Überwachen Sie GitHub-Releases, Changelogs oder Produkt-Updates
|
||||
- **Social-Media-Aggregation** - Sammeln Sie Inhalte von Plattformen, die RSS-Feeds anbieten
|
||||
|
||||
<Callout>
|
||||
RSS-Trigger werden nur für Einträge ausgelöst, die nach dem Speichern des Triggers veröffentlicht wurden. Bestehende Feed-Einträge werden nicht verarbeitet.
|
||||
</Callout>
|
||||
@@ -27,16 +27,14 @@ All API responses include information about your workflow execution limits and u
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60, // Sustained rate limit per minute
|
||||
"maxBurst": 120, // Maximum burst capacity
|
||||
"remaining": 118, // Current tokens available (up to maxBurst)
|
||||
"resetAt": "..." // When tokens next refill
|
||||
"limit": 60, // Max sync workflow executions per minute
|
||||
"remaining": 58, // Remaining sync workflow executions
|
||||
"resetAt": "..." // When the window resets
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200, // Sustained rate limit per minute
|
||||
"maxBurst": 400, // Maximum burst capacity
|
||||
"remaining": 398, // Current tokens available
|
||||
"resetAt": "..." // When tokens next refill
|
||||
"limit": 60, // Max async workflow executions per minute
|
||||
"remaining": 59, // Remaining async workflow executions
|
||||
"resetAt": "..." // When the window resets
|
||||
}
|
||||
},
|
||||
"usage": {
|
||||
@@ -48,7 +46,7 @@ All API responses include information about your workflow execution limits and u
|
||||
}
|
||||
```
|
||||
|
||||
**Note:** Rate limits use a token bucket algorithm. `remaining` can exceed `requestsPerMinute` up to `maxBurst` when you haven't used your full allowance recently, allowing for burst traffic. The rate limits in the response body are for workflow executions. The rate limits for calling this API endpoint are in the response headers (`X-RateLimit-*`).
|
||||
**Note:** The rate limits in the response body are for workflow executions. The rate limits for calling this API endpoint are in the response headers (`X-RateLimit-*`).
|
||||
|
||||
### Query Logs
|
||||
|
||||
@@ -110,15 +108,13 @@ Query workflow execution logs with extensive filtering options.
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60,
|
||||
"maxBurst": 120,
|
||||
"remaining": 118,
|
||||
"limit": 60,
|
||||
"remaining": 58,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 398,
|
||||
"limit": 60,
|
||||
"remaining": 59,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
}
|
||||
},
|
||||
@@ -188,15 +184,13 @@ Retrieve detailed information about a specific log entry.
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60,
|
||||
"maxBurst": 120,
|
||||
"remaining": 118,
|
||||
"limit": 60,
|
||||
"remaining": 58,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 398,
|
||||
"limit": 60,
|
||||
"remaining": 59,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
}
|
||||
},
|
||||
@@ -473,25 +467,17 @@ Failed webhook deliveries are retried with exponential backoff and jitter:
|
||||
|
||||
## Rate Limiting
|
||||
|
||||
The API uses a **token bucket algorithm** for rate limiting, providing fair usage while allowing burst traffic:
|
||||
The API implements rate limiting to ensure fair usage:
|
||||
|
||||
| Plan | Requests/Minute | Burst Capacity |
|
||||
|------|-----------------|----------------|
|
||||
| Free | 10 | 20 |
|
||||
| Pro | 30 | 60 |
|
||||
| Team | 60 | 120 |
|
||||
| Enterprise | 120 | 240 |
|
||||
|
||||
**How it works:**
|
||||
- Tokens refill at `requestsPerMinute` rate
|
||||
- You can accumulate up to `maxBurst` tokens when idle
|
||||
- Each request consumes 1 token
|
||||
- Burst capacity allows handling traffic spikes
|
||||
- **Free plan**: 10 requests per minute
|
||||
- **Pro plan**: 30 requests per minute
|
||||
- **Team plan**: 60 requests per minute
|
||||
- **Enterprise plan**: Custom limits
|
||||
|
||||
Rate limit information is included in response headers:
|
||||
- `X-RateLimit-Limit`: Requests per minute (refill rate)
|
||||
- `X-RateLimit-Remaining`: Current tokens available
|
||||
- `X-RateLimit-Reset`: ISO timestamp when tokens next refill
|
||||
- `X-RateLimit-Limit`: Maximum requests per window
|
||||
- `X-RateLimit-Remaining`: Requests remaining in current window
|
||||
- `X-RateLimit-Reset`: ISO timestamp when the window resets
|
||||
|
||||
## Example: Polling for New Logs
|
||||
|
||||
|
||||
@@ -143,20 +143,8 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
{
|
||||
"success": true,
|
||||
"rateLimit": {
|
||||
"sync": {
|
||||
"isLimited": false,
|
||||
"requestsPerMinute": 25,
|
||||
"maxBurst": 50,
|
||||
"remaining": 50,
|
||||
"resetAt": "2025-09-08T22:51:55.999Z"
|
||||
},
|
||||
"async": {
|
||||
"isLimited": false,
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 400,
|
||||
"resetAt": "2025-09-08T22:51:56.155Z"
|
||||
},
|
||||
"sync": { "isLimited": false, "limit": 10, "remaining": 10, "resetAt": "2025-09-08T22:51:55.999Z" },
|
||||
"async": { "isLimited": false, "limit": 50, "remaining": 50, "resetAt": "2025-09-08T22:51:56.155Z" },
|
||||
"authType": "api"
|
||||
},
|
||||
"usage": {
|
||||
@@ -167,11 +155,6 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
}
|
||||
```
|
||||
|
||||
**Rate Limit Fields:**
|
||||
- `requestsPerMinute`: Sustained rate limit (tokens refill at this rate)
|
||||
- `maxBurst`: Maximum tokens you can accumulate (burst capacity)
|
||||
- `remaining`: Current tokens available (can be up to `maxBurst`)
|
||||
|
||||
**Response Fields:**
|
||||
- `currentPeriodCost` reflects usage in the current billing period
|
||||
- `limit` is derived from individual limits (Free/Pro) or pooled organization limits (Team/Enterprise)
|
||||
|
||||
@@ -49,11 +49,11 @@ Search the web using Exa AI. Returns relevant search results with titles, URLs,
|
||||
| `type` | string | No | Search type: neural, keyword, auto or fast \(default: auto\) |
|
||||
| `includeDomains` | string | No | Comma-separated list of domains to include in results |
|
||||
| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results |
|
||||
| `category` | string | No | Filter by category: company, research paper, news, pdf, github, tweet, personal site, linkedin profile, financial report |
|
||||
| `category` | string | No | Filter by category: company, research_paper, news_article, pdf, github, tweet, movie, song, personal_site |
|
||||
| `text` | boolean | No | Include full text content in results \(default: false\) |
|
||||
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
|
||||
| `summary` | boolean | No | Include AI-generated summaries in results \(default: false\) |
|
||||
| `livecrawl` | string | No | Live crawling mode: never \(default\), fallback, always, or preferred \(always try livecrawl, fall back to cache if fails\) |
|
||||
| `livecrawl` | string | No | Live crawling mode: always, fallback, or never \(default: never\) |
|
||||
| `apiKey` | string | Yes | Exa AI API Key |
|
||||
|
||||
#### Output
|
||||
@@ -76,7 +76,7 @@ Retrieve the contents of webpages using Exa AI. Returns the title, text content,
|
||||
| `subpages` | number | No | Number of subpages to crawl from the provided URLs |
|
||||
| `subpageTarget` | string | No | Comma-separated keywords to target specific subpages \(e.g., "docs,tutorial,about"\) |
|
||||
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
|
||||
| `livecrawl` | string | No | Live crawling mode: never \(default\), fallback, always, or preferred \(always try livecrawl, fall back to cache if fails\) |
|
||||
| `livecrawl` | string | No | Live crawling mode: always, fallback, or never \(default: never\) |
|
||||
| `apiKey` | string | Yes | Exa AI API Key |
|
||||
|
||||
#### Output
|
||||
@@ -99,9 +99,10 @@ Find webpages similar to a given URL using Exa AI. Returns a list of similar lin
|
||||
| `includeDomains` | string | No | Comma-separated list of domains to include in results |
|
||||
| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results |
|
||||
| `excludeSourceDomain` | boolean | No | Exclude the source domain from results \(default: false\) |
|
||||
| `category` | string | No | Filter by category: company, research_paper, news_article, pdf, github, tweet, movie, song, personal_site |
|
||||
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
|
||||
| `summary` | boolean | No | Include AI-generated summaries in results \(default: false\) |
|
||||
| `livecrawl` | string | No | Live crawling mode: never \(default\), fallback, always, or preferred \(always try livecrawl, fall back to cache if fails\) |
|
||||
| `livecrawl` | string | No | Live crawling mode: always, fallback, or never \(default: never\) |
|
||||
| `apiKey` | string | Yes | Exa AI API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -52,8 +52,8 @@ Retrieve a list of prediction markets from Kalshi with optional filtering
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `markets` | array | Array of market objects |
|
||||
| `paging` | object | Pagination cursor for fetching more results |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Markets data and metadata |
|
||||
|
||||
### `kalshi_get_market`
|
||||
|
||||
@@ -69,7 +69,8 @@ Retrieve details of a specific prediction market by ticker
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `market` | object | Market object with details |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Market data and metadata |
|
||||
|
||||
### `kalshi_get_events`
|
||||
|
||||
@@ -89,8 +90,8 @@ Retrieve a list of events from Kalshi with optional filtering
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `events` | array | Array of event objects |
|
||||
| `paging` | object | Pagination cursor for fetching more results |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Events data and metadata |
|
||||
|
||||
### `kalshi_get_event`
|
||||
|
||||
@@ -107,7 +108,8 @@ Retrieve details of a specific event by ticker
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | Event object with details |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Event data and metadata |
|
||||
|
||||
### `kalshi_get_balance`
|
||||
|
||||
@@ -124,10 +126,8 @@ Retrieve your account balance and portfolio value from Kalshi
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `balance` | number | Account balance in cents |
|
||||
| `portfolioValue` | number | Portfolio value in cents |
|
||||
| `balanceDollars` | number | Account balance in dollars |
|
||||
| `portfolioValueDollars` | number | Portfolio value in dollars |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Balance data and metadata |
|
||||
|
||||
### `kalshi_get_positions`
|
||||
|
||||
@@ -149,8 +149,8 @@ Retrieve your open positions from Kalshi
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `positions` | array | Array of position objects |
|
||||
| `paging` | object | Pagination cursor for fetching more results |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Positions data and metadata |
|
||||
|
||||
### `kalshi_get_orders`
|
||||
|
||||
@@ -172,8 +172,8 @@ Retrieve your orders from Kalshi with optional filtering
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orders` | array | Array of order objects |
|
||||
| `paging` | object | Pagination cursor for fetching more results |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Orders data and metadata |
|
||||
|
||||
### `kalshi_get_order`
|
||||
|
||||
@@ -191,7 +191,8 @@ Retrieve details of a specific order by ID from Kalshi
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | Order object with details |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Order data |
|
||||
|
||||
### `kalshi_get_orderbook`
|
||||
|
||||
@@ -207,7 +208,8 @@ Retrieve the orderbook (yes and no bids) for a specific market
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orderbook` | object | Orderbook with yes/no bids and asks |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Orderbook data and metadata |
|
||||
|
||||
### `kalshi_get_trades`
|
||||
|
||||
@@ -224,8 +226,8 @@ Retrieve recent trades across all markets
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | array | Array of trade objects |
|
||||
| `paging` | object | Pagination cursor for fetching more results |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Trades data and metadata |
|
||||
|
||||
### `kalshi_get_candlesticks`
|
||||
|
||||
@@ -245,7 +247,8 @@ Retrieve OHLC candlestick data for a specific market
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `candlesticks` | array | Array of OHLC candlestick data |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Candlestick data and metadata |
|
||||
|
||||
### `kalshi_get_fills`
|
||||
|
||||
@@ -268,8 +271,8 @@ Retrieve your portfolio
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `fills` | array | Array of fill/trade objects |
|
||||
| `paging` | object | Pagination cursor for fetching more results |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Fills data and metadata |
|
||||
|
||||
### `kalshi_get_series_by_ticker`
|
||||
|
||||
@@ -285,7 +288,8 @@ Retrieve details of a specific market series by ticker
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | object | Series object with details |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Series data and metadata |
|
||||
|
||||
### `kalshi_get_exchange_status`
|
||||
|
||||
@@ -300,7 +304,8 @@ Retrieve the current status of the Kalshi exchange (trading and exchange activit
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | object | Exchange status with trading_active and exchange_active flags |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Exchange status data and metadata |
|
||||
|
||||
### `kalshi_create_order`
|
||||
|
||||
@@ -334,7 +339,8 @@ Create a new order on a Kalshi prediction market
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | The created order object |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Created order data |
|
||||
|
||||
### `kalshi_cancel_order`
|
||||
|
||||
@@ -352,8 +358,8 @@ Cancel an existing order on Kalshi
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | The canceled order object |
|
||||
| `reducedBy` | number | Number of contracts canceled |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Canceled order data |
|
||||
|
||||
### `kalshi_amend_order`
|
||||
|
||||
@@ -381,7 +387,8 @@ Modify the price or quantity of an existing order on Kalshi
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | The amended order object |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Amended order data |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -94,11 +94,11 @@ Conduct comprehensive deep research across the web using Parallel AI. Synthesize
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Task status \(completed, failed\) |
|
||||
| `status` | string | Task status \(running, completed, failed\) |
|
||||
| `run_id` | string | Unique ID for this research task |
|
||||
| `message` | string | Status message |
|
||||
| `message` | string | Status message \(for running tasks\) |
|
||||
| `content` | object | Research results \(structured based on output_schema\) |
|
||||
| `basis` | array | Citations and sources with reasoning and confidence levels |
|
||||
| `basis` | array | Citations and sources with excerpts and confidence levels |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -54,9 +54,8 @@ Generate completions using Perplexity AI chat models
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | Generated text content |
|
||||
| `model` | string | Model used for generation |
|
||||
| `usage` | object | Token usage information |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Chat completion results |
|
||||
|
||||
### `perplexity_search`
|
||||
|
||||
@@ -80,7 +79,8 @@ Get ranked search results from Perplexity
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Array of search results |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Search results |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -47,14 +47,15 @@ Retrieve a list of prediction markets from Polymarket with optional filtering
|
||||
| `order` | string | No | Sort field \(e.g., volumeNum, liquidityNum, startDate, endDate, createdAt\) |
|
||||
| `ascending` | string | No | Sort direction \(true for ascending, false for descending\) |
|
||||
| `tagId` | string | No | Filter by tag ID |
|
||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
||||
| `limit` | string | No | Number of results per page \(recommended: 25-50\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `markets` | array | Array of market objects |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Markets data and metadata |
|
||||
|
||||
### `polymarket_get_market`
|
||||
|
||||
@@ -71,7 +72,8 @@ Retrieve details of a specific prediction market by ID or slug
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `market` | object | Market object with details |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Market data and metadata |
|
||||
|
||||
### `polymarket_get_events`
|
||||
|
||||
@@ -85,14 +87,15 @@ Retrieve a list of events from Polymarket with optional filtering
|
||||
| `order` | string | No | Sort field \(e.g., volume, liquidity, startDate, endDate, createdAt\) |
|
||||
| `ascending` | string | No | Sort direction \(true for ascending, false for descending\) |
|
||||
| `tagId` | string | No | Filter by tag ID |
|
||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
||||
| `limit` | string | No | Number of results per page \(recommended: 25-50\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `events` | array | Array of event objects |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Events data and metadata |
|
||||
|
||||
### `polymarket_get_event`
|
||||
|
||||
@@ -109,7 +112,8 @@ Retrieve details of a specific event by ID or slug
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | Event object with details |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Event data and metadata |
|
||||
|
||||
### `polymarket_get_tags`
|
||||
|
||||
@@ -119,14 +123,15 @@ Retrieve available tags for filtering markets from Polymarket
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
||||
| `limit` | string | No | Number of results per page \(recommended: 25-50\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tags` | array | Array of tag objects with id, label, and slug |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Tags data and metadata |
|
||||
|
||||
### `polymarket_search`
|
||||
|
||||
@@ -137,14 +142,15 @@ Search for markets, events, and profiles on Polymarket
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | Search query term |
|
||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
||||
| `offset` | string | No | Pagination offset |
|
||||
| `limit` | string | No | Number of results per page \(recommended: 25-50\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | object | Search results containing markets, events, and profiles arrays |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Search results and metadata |
|
||||
|
||||
### `polymarket_get_series`
|
||||
|
||||
@@ -154,14 +160,15 @@ Retrieve series (related market groups) from Polymarket
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
||||
| `limit` | string | No | Number of results per page \(recommended: 25-50\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | array | Array of series objects |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Series data and metadata |
|
||||
|
||||
### `polymarket_get_series_by_id`
|
||||
|
||||
@@ -177,7 +184,8 @@ Retrieve a specific series (related market group) by ID from Polymarket
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | object | Series object with details |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Series data and metadata |
|
||||
|
||||
### `polymarket_get_orderbook`
|
||||
|
||||
@@ -193,7 +201,8 @@ Retrieve the order book summary for a specific token
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orderbook` | object | Order book with bids and asks arrays |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Orderbook data and metadata |
|
||||
|
||||
### `polymarket_get_price`
|
||||
|
||||
@@ -210,7 +219,8 @@ Retrieve the market price for a specific token and side
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `price` | string | Market price |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Price data and metadata |
|
||||
|
||||
### `polymarket_get_midpoint`
|
||||
|
||||
@@ -226,7 +236,8 @@ Retrieve the midpoint price for a specific token
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `midpoint` | string | Midpoint price |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Midpoint price data and metadata |
|
||||
|
||||
### `polymarket_get_price_history`
|
||||
|
||||
@@ -246,7 +257,8 @@ Retrieve historical price data for a specific market token
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `history` | array | Array of price history entries with timestamp \(t\) and price \(p\) |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Price history data and metadata |
|
||||
|
||||
### `polymarket_get_last_trade_price`
|
||||
|
||||
@@ -262,7 +274,8 @@ Retrieve the last trade price for a specific token
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `price` | string | Last trade price |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Last trade price and metadata |
|
||||
|
||||
### `polymarket_get_spread`
|
||||
|
||||
@@ -278,7 +291,8 @@ Retrieve the bid-ask spread for a specific token
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `spread` | object | Bid-ask spread with bid and ask prices |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Spread data and metadata |
|
||||
|
||||
### `polymarket_get_tick_size`
|
||||
|
||||
@@ -294,7 +308,8 @@ Retrieve the minimum tick size for a specific token
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tickSize` | string | Minimum tick size |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Tick size and metadata |
|
||||
|
||||
### `polymarket_get_positions`
|
||||
|
||||
@@ -311,7 +326,8 @@ Retrieve user positions from Polymarket
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `positions` | array | Array of position objects |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Positions data and metadata |
|
||||
|
||||
### `polymarket_get_trades`
|
||||
|
||||
@@ -323,14 +339,15 @@ Retrieve trade history from Polymarket
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `user` | string | No | User wallet address to filter trades |
|
||||
| `market` | string | No | Market ID to filter trades |
|
||||
| `limit` | string | No | Number of results per page \(max 50\) |
|
||||
| `limit` | string | No | Number of results per page \(recommended: 25-50\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | array | Array of trade objects |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Trades data and metadata |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -345,30 +345,19 @@ Delete an email template from SendGrid
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `message` | string | Status or success message |
|
||||
| `messageId` | string | Email message ID \(send_mail\) |
|
||||
| `to` | string | Recipient email address \(send_mail\) |
|
||||
| `subject` | string | Email subject \(send_mail, create_template_version\) |
|
||||
| `id` | string | Resource ID |
|
||||
| `jobId` | string | Job ID for async operations |
|
||||
| `email` | string | Contact email address |
|
||||
| `firstName` | string | Contact first name |
|
||||
| `lastName` | string | Contact last name |
|
||||
| `createdAt` | string | Creation timestamp |
|
||||
| `updatedAt` | string | Last update timestamp |
|
||||
| `listIds` | json | Array of list IDs the contact belongs to |
|
||||
| `customFields` | json | Custom field values |
|
||||
| `email` | string | Email address |
|
||||
| `firstName` | string | First name |
|
||||
| `lastName` | string | Last name |
|
||||
| `contacts` | json | Array of contacts |
|
||||
| `contactCount` | number | Number of contacts |
|
||||
| `lists` | json | Array of lists |
|
||||
| `name` | string | Resource name |
|
||||
| `templates` | json | Array of templates |
|
||||
| `message` | string | Status or success message |
|
||||
| `name` | string | Resource name |
|
||||
| `generation` | string | Template generation |
|
||||
| `versions` | json | Array of template versions |
|
||||
| `templateId` | string | Template ID |
|
||||
| `active` | boolean | Whether template version is active |
|
||||
| `htmlContent` | string | HTML content |
|
||||
| `plainContent` | string | Plain text content |
|
||||
|
||||
### `sendgrid_create_template_version`
|
||||
|
||||
|
||||
@@ -40,7 +40,7 @@ Processes a provided thought/instruction, making it available for subsequent ste
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `thought` | string | Yes | Your internal reasoning, analysis, or thought process. Use this to think through the problem step by step before responding. |
|
||||
| `thought` | string | Yes | The thought process or instruction provided by the user in the Thinking Step block. |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
@@ -34,30 +34,38 @@ Integrate Translate into the workflow. Can translate text to any language.
|
||||
|
||||
## Tools
|
||||
|
||||
### `llm_chat`
|
||||
|
||||
Send a chat completion request to any supported LLM provider
|
||||
### `openai_chat`
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `model` | string | Yes | The model to use \(e.g., gpt-4o, claude-sonnet-4-5, gemini-2.0-flash\) |
|
||||
| `systemPrompt` | string | No | System prompt to set the behavior of the assistant |
|
||||
| `context` | string | Yes | The user message or context to send to the model |
|
||||
| `apiKey` | string | No | API key for the provider \(uses platform key if not provided for hosted models\) |
|
||||
| `temperature` | number | No | Temperature for response generation \(0-2\) |
|
||||
| `maxTokens` | number | No | Maximum tokens in the response |
|
||||
| `azureEndpoint` | string | No | Azure OpenAI endpoint URL |
|
||||
| `azureApiVersion` | string | No | Azure OpenAI API version |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | The generated response content |
|
||||
| `model` | string | The model used for generation |
|
||||
| `tokens` | object | Token usage information |
|
||||
| `content` | string | Translated text |
|
||||
| `model` | string | Model used |
|
||||
| `tokens` | json | Token usage |
|
||||
|
||||
### `anthropic_chat`
|
||||
|
||||
|
||||
### `google_chat`
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | Translated text |
|
||||
| `model` | string | Model used |
|
||||
| `tokens` | json | Token usage |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -254,8 +254,8 @@ Upload a media file (image, video, document) to WordPress.com
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `file` | file | No | File to upload \(UserFile object\) |
|
||||
| `filename` | string | No | Optional filename override \(e.g., image.jpg\) |
|
||||
| `file` | string | Yes | Base64 encoded file data or URL to fetch file from |
|
||||
| `filename` | string | Yes | Filename with extension \(e.g., image.jpg\) |
|
||||
| `title` | string | No | Media title |
|
||||
| `caption` | string | No | Media caption |
|
||||
| `altText` | string | No | Alternative text for accessibility |
|
||||
|
||||
@@ -173,6 +173,25 @@ Get videos from a YouTube playlist.
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array of videos in the playlist |
|
||||
|
||||
### `youtube_related_videos`
|
||||
|
||||
Find videos related to a specific YouTube video.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `videoId` | string | Yes | YouTube video ID to find related videos for |
|
||||
| `maxResults` | number | No | Maximum number of related videos to return \(1-50\) |
|
||||
| `pageToken` | string | No | Page token for pagination |
|
||||
| `apiKey` | string | Yes | YouTube API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array of related videos |
|
||||
|
||||
### `youtube_comments`
|
||||
|
||||
Get comments from a YouTube video.
|
||||
|
||||
@@ -76,9 +76,8 @@ Retrieve a list of tickets from Zendesk with optional filtering
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tickets` | array | Array of ticket objects |
|
||||
| `paging` | object | Pagination information |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Tickets data and metadata |
|
||||
|
||||
### `zendesk_get_ticket`
|
||||
|
||||
@@ -97,8 +96,8 @@ Get a single ticket by ID from Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Ticket object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Ticket data |
|
||||
|
||||
### `zendesk_create_ticket`
|
||||
|
||||
@@ -126,8 +125,8 @@ Create a new ticket in Zendesk with support for custom fields
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Created ticket object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Created ticket data |
|
||||
|
||||
### `zendesk_create_tickets_bulk`
|
||||
|
||||
@@ -146,8 +145,8 @@ Create multiple tickets in Zendesk at once (max 100)
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Job status object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Bulk create job status |
|
||||
|
||||
### `zendesk_update_ticket`
|
||||
|
||||
@@ -175,8 +174,8 @@ Update an existing ticket in Zendesk with support for custom fields
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Updated ticket object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Updated ticket data |
|
||||
|
||||
### `zendesk_update_tickets_bulk`
|
||||
|
||||
@@ -200,8 +199,8 @@ Update multiple tickets in Zendesk at once (max 100)
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Job status object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Bulk update job status |
|
||||
|
||||
### `zendesk_delete_ticket`
|
||||
|
||||
@@ -220,8 +219,8 @@ Delete a ticket from Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Deletion success |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Delete confirmation |
|
||||
|
||||
### `zendesk_merge_tickets`
|
||||
|
||||
@@ -242,8 +241,8 @@ Merge multiple tickets into a target ticket
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Job status object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Merge job status |
|
||||
|
||||
### `zendesk_get_users`
|
||||
|
||||
@@ -265,9 +264,8 @@ Retrieve a list of users from Zendesk with optional filtering
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Array of user objects |
|
||||
| `paging` | object | Pagination information |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Users data and metadata |
|
||||
|
||||
### `zendesk_get_user`
|
||||
|
||||
@@ -286,8 +284,8 @@ Get a single user by ID from Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | User object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | User data |
|
||||
|
||||
### `zendesk_get_current_user`
|
||||
|
||||
@@ -305,8 +303,8 @@ Get the currently authenticated user from Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Current user object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Current user data |
|
||||
|
||||
### `zendesk_search_users`
|
||||
|
||||
@@ -328,9 +326,8 @@ Search for users in Zendesk using a query string
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Array of user objects |
|
||||
| `paging` | object | Pagination information |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Users search results |
|
||||
|
||||
### `zendesk_create_user`
|
||||
|
||||
@@ -356,8 +353,8 @@ Create a new user in Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Created user object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Created user data |
|
||||
|
||||
### `zendesk_create_users_bulk`
|
||||
|
||||
@@ -376,8 +373,8 @@ Create multiple users in Zendesk using bulk import
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Job status object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Bulk creation job status |
|
||||
|
||||
### `zendesk_update_user`
|
||||
|
||||
@@ -404,8 +401,8 @@ Update an existing user in Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Updated user object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Updated user data |
|
||||
|
||||
### `zendesk_update_users_bulk`
|
||||
|
||||
@@ -424,8 +421,8 @@ Update multiple users in Zendesk using bulk update
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Job status object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Bulk update job status |
|
||||
|
||||
### `zendesk_delete_user`
|
||||
|
||||
@@ -444,8 +441,8 @@ Delete a user from Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Deletion success |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Deleted user data |
|
||||
|
||||
### `zendesk_get_organizations`
|
||||
|
||||
@@ -465,9 +462,8 @@ Retrieve a list of organizations from Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | Array of organization objects |
|
||||
| `paging` | object | Pagination information |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Organizations data and metadata |
|
||||
|
||||
### `zendesk_get_organization`
|
||||
|
||||
@@ -486,8 +482,8 @@ Get a single organization by ID from Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | Organization object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Organization data |
|
||||
|
||||
### `zendesk_autocomplete_organizations`
|
||||
|
||||
@@ -508,9 +504,8 @@ Autocomplete organizations in Zendesk by name prefix (for name matching/autocomp
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | Array of organization objects |
|
||||
| `paging` | object | Pagination information |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Organizations search results |
|
||||
|
||||
### `zendesk_create_organization`
|
||||
|
||||
@@ -534,8 +529,8 @@ Create a new organization in Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | Created organization object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Created organization data |
|
||||
|
||||
### `zendesk_create_organizations_bulk`
|
||||
|
||||
@@ -554,8 +549,8 @@ Create multiple organizations in Zendesk using bulk import
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Job status object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Bulk creation job status |
|
||||
|
||||
### `zendesk_update_organization`
|
||||
|
||||
@@ -580,8 +575,8 @@ Update an existing organization in Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | Updated organization object |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Updated organization data |
|
||||
|
||||
### `zendesk_delete_organization`
|
||||
|
||||
@@ -600,8 +595,8 @@ Delete an organization from Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Deletion success |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Deleted organization data |
|
||||
|
||||
### `zendesk_search`
|
||||
|
||||
@@ -624,9 +619,8 @@ Unified search across tickets, users, and organizations in Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Array of result objects |
|
||||
| `paging` | object | Pagination information |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Search results |
|
||||
|
||||
### `zendesk_search_count`
|
||||
|
||||
@@ -645,8 +639,8 @@ Count the number of search results matching a query in Zendesk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `count` | number | Number of matching results |
|
||||
| `metadata` | object | Operation metadata |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Search count result |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -30,9 +30,6 @@ Use the Start block for everything originating from the editor, deploy-to-API, o
|
||||
<Card title="Schedule" href="/triggers/schedule">
|
||||
Cron or interval based execution
|
||||
</Card>
|
||||
<Card title="RSS Feed" href="/triggers/rss">
|
||||
Monitor RSS and Atom feeds for new content
|
||||
</Card>
|
||||
</Cards>
|
||||
|
||||
## Quick Comparison
|
||||
@@ -42,7 +39,6 @@ Use the Start block for everything originating from the editor, deploy-to-API, o
|
||||
| **Start** | Editor runs, deploy-to-API requests, or chat messages |
|
||||
| **Schedule** | Timer managed in schedule block |
|
||||
| **Webhook** | On inbound HTTP request |
|
||||
| **RSS Feed** | New item published to feed |
|
||||
|
||||
> The Start block always exposes `input`, `conversationId`, and `files` fields. Add custom fields to the input format for additional structured data.
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{
|
||||
"pages": ["index", "start", "schedule", "webhook", "rss"]
|
||||
"pages": ["index", "start", "schedule", "webhook"]
|
||||
}
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
title: RSS Feed
|
||||
---
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { Image } from '@/components/ui/image'
|
||||
|
||||
The RSS Feed block monitors RSS and Atom feeds – when new items are published, your workflow triggers automatically.
|
||||
|
||||
<div className="flex justify-center">
|
||||
<Image
|
||||
src="/static/blocks/rss.png"
|
||||
alt="RSS Feed Block"
|
||||
width={500}
|
||||
height={400}
|
||||
className="my-6"
|
||||
/>
|
||||
</div>
|
||||
|
||||
## Configuration
|
||||
|
||||
1. **Add RSS Feed Block** - Drag the RSS Feed block to start your workflow
|
||||
2. **Enter Feed URL** - Paste the URL of any RSS or Atom feed
|
||||
3. **Deploy** - Deploy your workflow to activate polling
|
||||
|
||||
Once deployed, the feed is checked every minute for new items.
|
||||
|
||||
## Output Fields
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `title` | string | Item title |
|
||||
| `link` | string | Item link |
|
||||
| `pubDate` | string | Publication date |
|
||||
| `item` | object | Raw item with all fields |
|
||||
| `feed` | object | Raw feed metadata |
|
||||
|
||||
Access mapped fields directly (`<rss.title>`) or use the raw objects for any field (`<rss.item.author>`, `<rss.feed.language>`).
|
||||
|
||||
## Use Cases
|
||||
|
||||
- **Content monitoring** - Track blogs, news sites, or competitor updates
|
||||
- **Podcast automation** - Trigger workflows when new episodes drop
|
||||
- **Release tracking** - Monitor GitHub releases, changelogs, or product updates
|
||||
- **Social aggregation** - Collect content from platforms that expose RSS feeds
|
||||
|
||||
<Callout>
|
||||
RSS triggers only fire for items published after you save the trigger. Existing feed items are not processed.
|
||||
</Callout>
|
||||
@@ -27,16 +27,14 @@ Todas las respuestas de la API incluyen información sobre tus límites de ejecu
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60, // Sustained rate limit per minute
|
||||
"maxBurst": 120, // Maximum burst capacity
|
||||
"remaining": 118, // Current tokens available (up to maxBurst)
|
||||
"resetAt": "..." // When tokens next refill
|
||||
"limit": 60, // Max sync workflow executions per minute
|
||||
"remaining": 58, // Remaining sync workflow executions
|
||||
"resetAt": "..." // When the window resets
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200, // Sustained rate limit per minute
|
||||
"maxBurst": 400, // Maximum burst capacity
|
||||
"remaining": 398, // Current tokens available
|
||||
"resetAt": "..." // When tokens next refill
|
||||
"limit": 60, // Max async workflow executions per minute
|
||||
"remaining": 59, // Remaining async workflow executions
|
||||
"resetAt": "..." // When the window resets
|
||||
}
|
||||
},
|
||||
"usage": {
|
||||
@@ -48,7 +46,7 @@ Todas las respuestas de la API incluyen información sobre tus límites de ejecu
|
||||
}
|
||||
```
|
||||
|
||||
**Nota:** Los límites de tasa utilizan un algoritmo de cubo de tokens. `remaining` puede exceder `requestsPerMinute` hasta `maxBurst` cuando no has usado tu asignación completa recientemente, permitiendo tráfico en ráfagas. Los límites de tasa en el cuerpo de la respuesta son para ejecuciones de flujo de trabajo. Los límites de tasa para llamar a este punto final de la API están en los encabezados de respuesta (`X-RateLimit-*`).
|
||||
**Nota:** Los límites de tasa en el cuerpo de la respuesta son para ejecuciones de flujos de trabajo. Los límites de tasa para llamar a este endpoint de la API están en los encabezados de respuesta (`X-RateLimit-*`).
|
||||
|
||||
### Consultar registros
|
||||
|
||||
@@ -112,15 +110,13 @@ Consulta los registros de ejecución de flujos de trabajo con amplias opciones d
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60,
|
||||
"maxBurst": 120,
|
||||
"remaining": 118,
|
||||
"limit": 60,
|
||||
"remaining": 58,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 398,
|
||||
"limit": 60,
|
||||
"remaining": 59,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
}
|
||||
},
|
||||
@@ -194,15 +190,13 @@ Recupera información detallada sobre una entrada de registro específica.
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60,
|
||||
"maxBurst": 120,
|
||||
"remaining": 118,
|
||||
"limit": 60,
|
||||
"remaining": 58,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 398,
|
||||
"limit": 60,
|
||||
"remaining": 59,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
}
|
||||
},
|
||||
@@ -488,27 +482,19 @@ Las entregas de webhook fallidas se reintentan con retroceso exponencial y fluct
|
||||
|
||||
## Limitación de tasa
|
||||
|
||||
La API utiliza un **algoritmo de cubo de tokens** para limitar la tasa, proporcionando un uso justo mientras permite tráfico en ráfagas:
|
||||
La API implementa limitación de tasa para asegurar un uso justo:
|
||||
|
||||
| Plan | Solicitudes/Minuto | Capacidad de ráfaga |
|
||||
|------|-----------------|----------------|
|
||||
| Free | 10 | 20 |
|
||||
| Pro | 30 | 60 |
|
||||
| Team | 60 | 120 |
|
||||
| Enterprise | 120 | 240 |
|
||||
- **Plan gratuito**: 10 solicitudes por minuto
|
||||
- **Plan Pro**: 30 solicitudes por minuto
|
||||
- **Plan Team**: 60 solicitudes por minuto
|
||||
- **Plan Enterprise**: Límites personalizados
|
||||
|
||||
**Cómo funciona:**
|
||||
- Los tokens se recargan a una tasa de `requestsPerMinute`
|
||||
- Puedes acumular hasta `maxBurst` tokens cuando estás inactivo
|
||||
- Cada solicitud consume 1 token
|
||||
- La capacidad de ráfaga permite manejar picos de tráfico
|
||||
La información de límite de tasa se incluye en las cabeceras de respuesta:
|
||||
- `X-RateLimit-Limit`: Solicitudes máximas por ventana
|
||||
- `X-RateLimit-Remaining`: Solicitudes restantes en la ventana actual
|
||||
- `X-RateLimit-Reset`: Marca de tiempo ISO cuando la ventana se reinicia
|
||||
|
||||
La información del límite de tasa se incluye en los encabezados de respuesta:
|
||||
- `X-RateLimit-Limit`: Solicitudes por minuto (tasa de recarga)
|
||||
- `X-RateLimit-Remaining`: Tokens disponibles actualmente
|
||||
- `X-RateLimit-Reset`: Marca de tiempo ISO cuando los tokens se recargan nuevamente
|
||||
|
||||
## Ejemplo: Sondeo para nuevos registros
|
||||
## Ejemplo: Sondeo de nuevos registros
|
||||
|
||||
```javascript
|
||||
let cursor = null;
|
||||
|
||||
@@ -147,20 +147,8 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
{
|
||||
"success": true,
|
||||
"rateLimit": {
|
||||
"sync": {
|
||||
"isLimited": false,
|
||||
"requestsPerMinute": 25,
|
||||
"maxBurst": 50,
|
||||
"remaining": 50,
|
||||
"resetAt": "2025-09-08T22:51:55.999Z"
|
||||
},
|
||||
"async": {
|
||||
"isLimited": false,
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 400,
|
||||
"resetAt": "2025-09-08T22:51:56.155Z"
|
||||
},
|
||||
"sync": { "isLimited": false, "limit": 10, "remaining": 10, "resetAt": "2025-09-08T22:51:55.999Z" },
|
||||
"async": { "isLimited": false, "limit": 50, "remaining": 50, "resetAt": "2025-09-08T22:51:56.155Z" },
|
||||
"authType": "api"
|
||||
},
|
||||
"usage": {
|
||||
@@ -171,11 +159,6 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
}
|
||||
```
|
||||
|
||||
**Campos de límite de tasa:**
|
||||
- `requestsPerMinute`: Límite de tasa sostenida (los tokens se recargan a esta velocidad)
|
||||
- `maxBurst`: Máximo de tokens que puedes acumular (capacidad de ráfaga)
|
||||
- `remaining`: Tokens disponibles actualmente (puede ser hasta `maxBurst`)
|
||||
|
||||
**Campos de respuesta:**
|
||||
- `currentPeriodCost` refleja el uso en el período de facturación actual
|
||||
- `limit` se deriva de límites individuales (Gratuito/Pro) o límites agrupados de la organización (Equipo/Empresa)
|
||||
@@ -187,38 +170,38 @@ Los diferentes planes de suscripción tienen diferentes límites de uso:
|
||||
|
||||
| Plan | Límite de uso mensual | Límites de tasa (por minuto) |
|
||||
|------|-------------------|-------------------------|
|
||||
| **Gratuito** | $10 | 5 sincrónico, 10 asincrónico |
|
||||
| **Pro** | $100 | 10 sincrónico, 50 asincrónico |
|
||||
| **Equipo** | $500 (agrupado) | 50 sincrónico, 100 asincrónico |
|
||||
| **Gratuito** | $10 | 5 sinc, 10 asinc |
|
||||
| **Pro** | $100 | 10 sinc, 50 asinc |
|
||||
| **Equipo** | $500 (agrupado) | 50 sinc, 100 asinc |
|
||||
| **Empresa** | Personalizado | Personalizado |
|
||||
|
||||
## Modelo de facturación
|
||||
|
||||
Sim utiliza un modelo de facturación de **suscripción base + excedente**:
|
||||
Sim utiliza un modelo de facturación de **suscripción base + exceso**:
|
||||
|
||||
### Cómo funciona
|
||||
|
||||
**Plan Pro ($20/mes):**
|
||||
- La suscripción mensual incluye $20 de uso
|
||||
- Uso por debajo de $20 → Sin cargos adicionales
|
||||
- Uso por encima de $20 → Pagas el excedente al final del mes
|
||||
- Ejemplo: $35 de uso = $20 (suscripción) + $15 (excedente)
|
||||
- Uso por encima de $20 → Pagas el exceso al final del mes
|
||||
- Ejemplo: $35 de uso = $20 (suscripción) + $15 (exceso)
|
||||
|
||||
**Plan de Equipo ($40/usuario/mes):**
|
||||
**Plan de equipo ($40/usuario/mes):**
|
||||
- Uso agrupado entre todos los miembros del equipo
|
||||
- Excedente calculado del uso total del equipo
|
||||
- Exceso calculado del uso total del equipo
|
||||
- El propietario de la organización recibe una sola factura
|
||||
|
||||
**Planes Empresariales:**
|
||||
- Precio mensual fijo, sin excedentes
|
||||
**Planes empresariales:**
|
||||
- Precio mensual fijo, sin excesos
|
||||
- Límites de uso personalizados según el acuerdo
|
||||
|
||||
### Facturación por umbral
|
||||
|
||||
Cuando el excedente no facturado alcanza los $50, Sim factura automáticamente el monto total no facturado.
|
||||
Cuando el exceso no facturado alcanza los $50, Sim factura automáticamente el monto total no facturado.
|
||||
|
||||
**Ejemplo:**
|
||||
- Día 10: $70 de excedente → Factura inmediata de $70
|
||||
- Día 10: $70 de exceso → Factura inmediata de $70
|
||||
- Día 15: $35 adicionales de uso ($105 en total) → Ya facturado, sin acción
|
||||
- Día 20: Otros $50 de uso ($155 en total, $85 no facturados) → Factura inmediata de $85
|
||||
|
||||
@@ -226,8 +209,8 @@ Esto distribuye los cargos por exceso a lo largo del mes en lugar de una gran fa
|
||||
|
||||
## Mejores prácticas para la gestión de costos
|
||||
|
||||
1. **Monitorear regularmente**: Revisa tu panel de uso con frecuencia para evitar sorpresas
|
||||
2. **Establecer presupuestos**: Utiliza los límites del plan como guías para tu gasto
|
||||
1. **Monitorear regularmente**: Revisa tu panel de uso frecuentemente para evitar sorpresas
|
||||
2. **Establecer presupuestos**: Usa los límites del plan como guías para tu gasto
|
||||
3. **Optimizar flujos de trabajo**: Revisa las ejecuciones de alto costo y optimiza los prompts o la selección de modelos
|
||||
4. **Usar modelos apropiados**: Ajusta la complejidad del modelo a los requisitos de la tarea
|
||||
5. **Agrupar tareas similares**: Combina múltiples solicitudes cuando sea posible para reducir la sobrecarga
|
||||
|
||||
@@ -46,11 +46,11 @@ Busca en la web usando Exa AI. Devuelve resultados de búsqueda relevantes con t
|
||||
| `type` | string | No | Tipo de búsqueda: neural, keyword, auto o fast \(predeterminado: auto\) |
|
||||
| `includeDomains` | string | No | Lista separada por comas de dominios a incluir en los resultados |
|
||||
| `excludeDomains` | string | No | Lista separada por comas de dominios a excluir de los resultados |
|
||||
| `category` | string | No | Filtrar por categoría: company, research paper, news, pdf, github, tweet, personal site, linkedin profile, financial report |
|
||||
| `category` | string | No | Filtrar por categoría: company, research_paper, news_article, pdf, github, tweet, movie, song, personal_site |
|
||||
| `text` | boolean | No | Incluir contenido de texto completo en los resultados \(predeterminado: false\) |
|
||||
| `highlights` | boolean | No | Incluir fragmentos destacados en los resultados \(predeterminado: false\) |
|
||||
| `summary` | boolean | No | Incluir resúmenes generados por IA en los resultados \(predeterminado: false\) |
|
||||
| `livecrawl` | string | No | Modo de rastreo en vivo: never \(predeterminado\), fallback, always, o preferred \(siempre intenta livecrawl, recurre a caché si falla\) |
|
||||
| `livecrawl` | string | No | Modo de rastreo en vivo: always, fallback o never \(predeterminado: never\) |
|
||||
| `apiKey` | string | Sí | Clave API de Exa AI |
|
||||
|
||||
#### Salida
|
||||
@@ -67,13 +67,13 @@ Recupera el contenido de páginas web usando Exa AI. Devuelve el título, conten
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `urls` | string | Sí | Lista separada por comas de URLs para recuperar contenido |
|
||||
| `urls` | string | Sí | Lista separada por comas de URLs de las que recuperar contenido |
|
||||
| `text` | boolean | No | Si es true, devuelve el texto completo de la página con la configuración predeterminada. Si es false, desactiva la devolución de texto. |
|
||||
| `summaryQuery` | string | No | Consulta para guiar la generación del resumen |
|
||||
| `subpages` | number | No | Número de subpáginas a rastrear desde las URLs proporcionadas |
|
||||
| `subpageTarget` | string | No | Palabras clave separadas por comas para dirigirse a subpáginas específicas \(por ejemplo, "docs,tutorial,about"\) |
|
||||
| `highlights` | boolean | No | Incluir fragmentos destacados en los resultados \(predeterminado: false\) |
|
||||
| `livecrawl` | string | No | Modo de rastreo en vivo: never \(predeterminado\), fallback, always, o preferred \(siempre intenta livecrawl, recurre a caché si falla\) |
|
||||
| `livecrawl` | string | No | Modo de rastreo en vivo: always, fallback o never \(predeterminado: never\) |
|
||||
| `apiKey` | string | Sí | Clave API de Exa AI |
|
||||
|
||||
#### Salida
|
||||
@@ -96,9 +96,10 @@ Encuentra páginas web similares a una URL determinada utilizando Exa AI. Devuel
|
||||
| `includeDomains` | string | No | Lista separada por comas de dominios a incluir en los resultados |
|
||||
| `excludeDomains` | string | No | Lista separada por comas de dominios a excluir de los resultados |
|
||||
| `excludeSourceDomain` | boolean | No | Excluir el dominio de origen de los resultados \(predeterminado: false\) |
|
||||
| `category` | string | No | Filtrar por categoría: company, research_paper, news_article, pdf, github, tweet, movie, song, personal_site |
|
||||
| `highlights` | boolean | No | Incluir fragmentos destacados en los resultados \(predeterminado: false\) |
|
||||
| `summary` | boolean | No | Incluir resúmenes generados por IA en los resultados \(predeterminado: false\) |
|
||||
| `livecrawl` | string | No | Modo de rastreo en vivo: never \(predeterminado\), fallback, always o preferred \(siempre intenta rastreo en vivo, recurre a caché si falla\) |
|
||||
| `livecrawl` | string | No | Modo de rastreo en vivo: always, fallback o never \(predeterminado: never\) |
|
||||
| `apiKey` | string | Sí | Clave API de Exa AI |
|
||||
|
||||
#### Salida
|
||||
|
||||
@@ -49,8 +49,8 @@ Obtener una lista de mercados de predicción de Kalshi con filtrado opcional
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `markets` | array | Array de objetos de mercado |
|
||||
| `paging` | object | Cursor de paginación para obtener más resultados |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de mercados y metadatos |
|
||||
|
||||
### `kalshi_get_market`
|
||||
|
||||
@@ -66,7 +66,8 @@ Obtener detalles de un mercado de predicción específico por ticker
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `market` | object | Objeto de mercado con detalles |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del mercado y metadatos |
|
||||
|
||||
### `kalshi_get_events`
|
||||
|
||||
@@ -86,8 +87,8 @@ Obtener una lista de eventos de Kalshi con filtrado opcional
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `events` | array | Array de objetos de eventos |
|
||||
| `paging` | object | Cursor de paginación para obtener más resultados |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos de eventos |
|
||||
|
||||
### `kalshi_get_event`
|
||||
|
||||
@@ -104,7 +105,8 @@ Recuperar detalles de un evento específico por ticker
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | Objeto de evento con detalles |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos del evento |
|
||||
|
||||
### `kalshi_get_balance`
|
||||
|
||||
@@ -121,10 +123,8 @@ Recuperar el saldo de tu cuenta y el valor de la cartera desde Kalshi
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `balance` | number | Saldo de la cuenta en centavos |
|
||||
| `portfolioValue` | number | Valor de la cartera en centavos |
|
||||
| `balanceDollars` | number | Saldo de la cuenta en dólares |
|
||||
| `portfolioValueDollars` | number | Valor de la cartera en dólares |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos del saldo |
|
||||
|
||||
### `kalshi_get_positions`
|
||||
|
||||
@@ -146,8 +146,8 @@ Recuperar tus posiciones abiertas desde Kalshi
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `positions` | array | Array de objetos de posición |
|
||||
| `paging` | object | Cursor de paginación para obtener más resultados |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de posiciones y metadatos |
|
||||
|
||||
### `kalshi_get_orders`
|
||||
|
||||
@@ -169,8 +169,8 @@ Recupera tus órdenes de Kalshi con filtrado opcional
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orders` | array | Array de objetos de órdenes |
|
||||
| `paging` | object | Cursor de paginación para obtener más resultados |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de órdenes y metadatos |
|
||||
|
||||
### `kalshi_get_order`
|
||||
|
||||
@@ -188,7 +188,8 @@ Recupera detalles de una orden específica por ID desde Kalshi
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | Objeto de orden con detalles |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de la orden |
|
||||
|
||||
### `kalshi_get_orderbook`
|
||||
|
||||
@@ -204,7 +205,8 @@ Recupera el libro de órdenes (ofertas de sí y no) para un mercado específico
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orderbook` | object | Libro de órdenes con ofertas y demandas de sí/no |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del libro de órdenes y metadatos |
|
||||
|
||||
### `kalshi_get_trades`
|
||||
|
||||
@@ -221,8 +223,8 @@ Recupera operaciones recientes de todos los mercados
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | array | Array de objetos de operaciones |
|
||||
| `paging` | object | Cursor de paginación para obtener más resultados |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de operaciones y metadatos |
|
||||
|
||||
### `kalshi_get_candlesticks`
|
||||
|
||||
@@ -242,7 +244,8 @@ Obtener datos de velas OHLC para un mercado específico
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `candlesticks` | array | Array de datos de velas OHLC |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de velas y metadatos |
|
||||
|
||||
### `kalshi_get_fills`
|
||||
|
||||
@@ -265,8 +268,8 @@ Recuperar tu portafolio
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `fills` | array | Array de objetos de ejecuciones/operaciones |
|
||||
| `paging` | object | Cursor de paginación para obtener más resultados |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de ejecuciones y metadatos |
|
||||
|
||||
### `kalshi_get_series_by_ticker`
|
||||
|
||||
@@ -282,7 +285,8 @@ Obtener detalles de una serie de mercado específica por ticker
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | object | Objeto de serie con detalles |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de la serie y metadatos |
|
||||
|
||||
### `kalshi_get_exchange_status`
|
||||
|
||||
@@ -297,7 +301,8 @@ Obtener el estado actual del intercambio Kalshi (actividad de trading y del inte
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | object | Estado del exchange con indicadores trading_active y exchange_active |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del estado del intercambio y metadatos |
|
||||
|
||||
### `kalshi_create_order`
|
||||
|
||||
@@ -331,7 +336,8 @@ Crear una nueva orden en un mercado de predicción de Kalshi
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | El objeto de orden creada |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de la orden creada |
|
||||
|
||||
### `kalshi_cancel_order`
|
||||
|
||||
@@ -349,8 +355,8 @@ Cancelar una orden existente en Kalshi
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | El objeto de orden cancelada |
|
||||
| `reducedBy` | number | Número de contratos cancelados |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de la orden cancelada |
|
||||
|
||||
### `kalshi_amend_order`
|
||||
|
||||
@@ -378,7 +384,8 @@ Modificar el precio o la cantidad de una orden existente en Kalshi
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | El objeto de orden modificada |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de la orden modificada |
|
||||
|
||||
## Notas
|
||||
|
||||
|
||||
@@ -91,11 +91,11 @@ Realiza investigaciones exhaustivas y profundas en la web utilizando Parallel AI
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Estado de la tarea (completada, fallida) |
|
||||
| `status` | string | Estado de la tarea (en ejecución, completada, fallida) |
|
||||
| `run_id` | string | ID único para esta tarea de investigación |
|
||||
| `message` | string | Mensaje de estado |
|
||||
| `message` | string | Mensaje de estado (para tareas en ejecución) |
|
||||
| `content` | object | Resultados de la investigación (estructurados según output_schema) |
|
||||
| `basis` | array | Citas y fuentes con razonamiento y niveles de confianza |
|
||||
| `basis` | array | Citas y fuentes con extractos y niveles de confianza |
|
||||
|
||||
## Notas
|
||||
|
||||
|
||||
@@ -51,9 +51,8 @@ Genera completados utilizando los modelos de chat de Perplexity AI
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | Contenido de texto generado |
|
||||
| `model` | string | Modelo utilizado para la generación |
|
||||
| `usage` | object | Información de uso de tokens |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Resultados del completado de chat |
|
||||
|
||||
### `perplexity_search`
|
||||
|
||||
@@ -77,7 +76,8 @@ Obtén resultados de búsqueda clasificados de Perplexity
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Array de resultados de búsqueda |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Resultados de búsqueda |
|
||||
|
||||
## Notas
|
||||
|
||||
|
||||
@@ -38,20 +38,21 @@ Obtener una lista de mercados de predicción de Polymarket con filtrado opcional
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `closed` | string | No | Filtrar por estado cerrado \(true/false\). Use false para mostrar solo mercados activos. |
|
||||
| `order` | string | No | Campo de ordenación \(p. ej., volumeNum, liquidityNum, startDate, endDate, createdAt\) |
|
||||
| `ascending` | string | No | Dirección de ordenación \(true para ascendente, false para descendente\) |
|
||||
| `tagId` | string | No | Filtrar por ID de etiqueta |
|
||||
| `limit` | string | No | Número de resultados por página \(máximo 50\) |
|
||||
| `limit` | string | No | Número de resultados por página \(recomendado: 25-50\) |
|
||||
| `offset` | string | No | Desplazamiento de paginación \(omitir esta cantidad de resultados\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `markets` | array | Array de objetos de mercado |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de mercados y metadatos |
|
||||
|
||||
### `polymarket_get_market`
|
||||
|
||||
@@ -68,7 +69,8 @@ Obtener detalles de un mercado de predicción específico por ID o slug
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `market` | object | Objeto de mercado con detalles |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de mercado y metadatos |
|
||||
|
||||
### `polymarket_get_events`
|
||||
|
||||
@@ -76,20 +78,21 @@ Obtener una lista de eventos de Polymarket con filtrado opcional
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `closed` | string | No | Filtrar por estado cerrado \(true/false\). Use false para mostrar solo eventos activos. |
|
||||
| `order` | string | No | Campo de ordenación \(p. ej., volume, liquidity, startDate, endDate, createdAt\) |
|
||||
| `ascending` | string | No | Dirección de ordenación \(true para ascendente, false para descendente\) |
|
||||
| `tagId` | string | No | Filtrar por ID de etiqueta |
|
||||
| `limit` | string | No | Número de resultados por página \(máximo 50\) |
|
||||
| `limit` | string | No | Número de resultados por página \(recomendado: 25-50\) |
|
||||
| `offset` | string | No | Desplazamiento de paginación \(omitir esta cantidad de resultados\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `events` | array | Array de objetos de eventos |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de eventos y metadatos |
|
||||
|
||||
### `polymarket_get_event`
|
||||
|
||||
@@ -106,7 +109,8 @@ Obtener detalles de un evento específico por ID o slug
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | Objeto de evento con detalles |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos del evento |
|
||||
|
||||
### `polymarket_get_tags`
|
||||
|
||||
@@ -116,14 +120,15 @@ Obtener etiquetas disponibles para filtrar mercados de Polymarket
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | No | Número de resultados por página \(máx 50\) |
|
||||
| `limit` | string | No | Número de resultados por página \(recomendado: 25-50\) |
|
||||
| `offset` | string | No | Desplazamiento de paginación \(omitir esta cantidad de resultados\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tags` | array | Array de objetos de etiquetas con id, etiqueta y slug |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos de etiquetas |
|
||||
|
||||
### `polymarket_search`
|
||||
|
||||
@@ -134,14 +139,15 @@ Buscar mercados, eventos y perfiles en Polymarket
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Sí | Término de búsqueda |
|
||||
| `limit` | string | No | Número de resultados por página \(máx 50\) |
|
||||
| `offset` | string | No | Desplazamiento de paginación |
|
||||
| `limit` | string | No | Número de resultados por página \(recomendado: 25-50\) |
|
||||
| `offset` | string | No | Desplazamiento de paginación \(omitir esta cantidad de resultados\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | object | Resultados de búsqueda que contienen arrays de mercados, eventos y perfiles |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Resultados de búsqueda y metadatos |
|
||||
|
||||
### `polymarket_get_series`
|
||||
|
||||
@@ -151,7 +157,7 @@ Obtener series (grupos de mercados relacionados) de Polymarket
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | No | Número de resultados por página \(máx 50\) |
|
||||
| `limit` | string | No | Número de resultados por página \(recomendado: 25-50\) |
|
||||
| `offset` | string | No | Desplazamiento de paginación \(omitir esta cantidad de resultados\) |
|
||||
|
||||
#### Salida
|
||||
@@ -159,7 +165,7 @@ Obtener series (grupos de mercados relacionados) de Polymarket
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de series y metadatos |
|
||||
| `output` | object | Datos y metadatos de la serie |
|
||||
|
||||
### `polymarket_get_series_by_id`
|
||||
|
||||
@@ -176,7 +182,7 @@ Recuperar una serie específica (grupo de mercado relacionado) por ID desde Poly
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de serie y metadatos |
|
||||
| `output` | object | Datos y metadatos de la serie |
|
||||
|
||||
### `polymarket_get_orderbook`
|
||||
|
||||
@@ -193,7 +199,7 @@ Recuperar el resumen del libro de órdenes para un token específico
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del libro de órdenes y metadatos |
|
||||
| `output` | object | Datos y metadatos del libro de órdenes |
|
||||
|
||||
### `polymarket_get_price`
|
||||
|
||||
@@ -211,7 +217,7 @@ Recuperar el precio de mercado para un token y lado específicos
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de precio de mercado y metadatos |
|
||||
| `output` | object | Datos de precio y metadatos |
|
||||
|
||||
### `polymarket_get_midpoint`
|
||||
|
||||
@@ -228,7 +234,7 @@ Recuperar el precio medio para un token específico
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de precio medio y metadatos |
|
||||
| `output` | object | Datos del precio medio y metadatos |
|
||||
|
||||
### `polymarket_get_price_history`
|
||||
|
||||
@@ -266,7 +272,7 @@ Recuperar el último precio de operación para un token específico
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del último precio de operación y metadatos |
|
||||
| `output` | object | Último precio de operación y metadatos |
|
||||
|
||||
### `polymarket_get_spread`
|
||||
|
||||
@@ -283,7 +289,7 @@ Recuperar el diferencial de oferta y demanda para un token específico
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del diferencial de compra-venta y metadatos |
|
||||
| `output` | object | Datos del diferencial y metadatos |
|
||||
|
||||
### `polymarket_get_tick_size`
|
||||
|
||||
@@ -300,7 +306,7 @@ Recuperar el tamaño mínimo de tick para un token específico
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del tamaño mínimo de tick y metadatos |
|
||||
| `output` | object | Tamaño del tick y metadatos |
|
||||
|
||||
### `polymarket_get_positions`
|
||||
|
||||
@@ -326,18 +332,19 @@ Recuperar historial de operaciones de Polymarket
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `user` | string | No | Dirección de la cartera del usuario para filtrar operaciones |
|
||||
| `market` | string | No | ID de mercado para filtrar operaciones |
|
||||
| `limit` | string | No | Número de resultados por página \(máximo 50\) |
|
||||
| `limit` | string | No | Número de resultados por página \(recomendado: 25-50\) |
|
||||
| `offset` | string | No | Desplazamiento de paginación \(omitir esta cantidad de resultados\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | array | Array de objetos de operaciones |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de operaciones y metadatos |
|
||||
|
||||
## Notas
|
||||
|
||||
|
||||
@@ -343,30 +343,19 @@ Eliminar una plantilla de correo electrónico de SendGrid
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `message` | string | Mensaje de estado o éxito |
|
||||
| `messageId` | string | ID del mensaje de correo electrónico \(send_mail\) |
|
||||
| `to` | string | Dirección de correo electrónico del destinatario \(send_mail\) |
|
||||
| `subject` | string | Asunto del correo electrónico \(send_mail, create_template_version\) |
|
||||
| `id` | string | ID del recurso |
|
||||
| `jobId` | string | ID de trabajo para operaciones asíncronas |
|
||||
| `email` | string | Dirección de correo electrónico del contacto |
|
||||
| `firstName` | string | Nombre del contacto |
|
||||
| `lastName` | string | Apellido del contacto |
|
||||
| `createdAt` | string | Marca de tiempo de creación |
|
||||
| `updatedAt` | string | Marca de tiempo de última actualización |
|
||||
| `listIds` | json | Array de IDs de listas a las que pertenece el contacto |
|
||||
| `customFields` | json | Valores de campos personalizados |
|
||||
| `jobId` | string | ID del trabajo para operaciones asíncronas |
|
||||
| `email` | string | Dirección de correo electrónico |
|
||||
| `firstName` | string | Nombre |
|
||||
| `lastName` | string | Apellido |
|
||||
| `contacts` | json | Array de contactos |
|
||||
| `contactCount` | number | Número de contactos |
|
||||
| `lists` | json | Array de listas |
|
||||
| `name` | string | Nombre del recurso |
|
||||
| `templates` | json | Array de plantillas |
|
||||
| `message` | string | Estado o mensaje de éxito |
|
||||
| `name` | string | Nombre del recurso |
|
||||
| `generation` | string | Generación de plantilla |
|
||||
| `versions` | json | Array de versiones de plantilla |
|
||||
| `templateId` | string | ID de plantilla |
|
||||
| `active` | boolean | Si la versión de la plantilla está activa |
|
||||
| `htmlContent` | string | Contenido HTML |
|
||||
| `plainContent` | string | Contenido de texto plano |
|
||||
|
||||
### `sendgrid_create_template_version`
|
||||
|
||||
|
||||
@@ -1,184 +0,0 @@
|
||||
---
|
||||
title: SFTP
|
||||
description: Transferir archivos a través de SFTP (Protocolo de transferencia de
|
||||
archivos SSH)
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="sftp"
|
||||
color="#2D3748"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[SFTP (Protocolo de transferencia de archivos SSH)](https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol) es un protocolo de red seguro que te permite subir, descargar y gestionar archivos en servidores remotos. SFTP opera sobre SSH, lo que lo hace ideal para transferencias de archivos automatizadas y cifradas, así como para la gestión remota de archivos dentro de flujos de trabajo modernos.
|
||||
|
||||
Con las herramientas SFTP integradas en Sim, puedes automatizar fácilmente el movimiento de archivos entre tus agentes de IA y sistemas o servidores externos. Esto permite a tus agentes gestionar intercambios críticos de datos, copias de seguridad, generación de documentos y orquestación de sistemas remotos, todo con una seguridad robusta.
|
||||
|
||||
**Funcionalidades clave disponibles a través de las herramientas SFTP:**
|
||||
|
||||
- **Subir archivos:** Transfiere sin problemas archivos de cualquier tipo desde tu flujo de trabajo a un servidor remoto, con soporte tanto para autenticación por contraseña como por clave privada SSH.
|
||||
- **Descargar archivos:** Recupera archivos de servidores SFTP remotos directamente para su procesamiento, archivo o automatización adicional.
|
||||
- **Listar y gestionar archivos:** Enumera directorios, elimina o crea archivos y carpetas, y gestiona permisos del sistema de archivos de forma remota.
|
||||
- **Autenticación flexible:** Conéctate usando contraseñas tradicionales o claves SSH, con soporte para frases de contraseña y control de permisos.
|
||||
- **Soporte para archivos grandes:** Gestiona programáticamente cargas y descargas de archivos grandes, con límites de tamaño incorporados para mayor seguridad.
|
||||
|
||||
Al integrar SFTP en Sim, puedes automatizar operaciones seguras de archivos como parte de cualquier flujo de trabajo, ya sea recopilación de datos, informes, mantenimiento de sistemas remotos o intercambio dinámico de contenido entre plataformas.
|
||||
|
||||
Las secciones a continuación describen las principales herramientas SFTP disponibles:
|
||||
|
||||
- **sftp_upload:** Sube uno o más archivos a un servidor remoto.
|
||||
- **sftp_download:** Descarga archivos desde un servidor remoto a tu flujo de trabajo.
|
||||
- **sftp_list:** Lista el contenido de directorios en un servidor SFTP remoto.
|
||||
- **sftp_delete:** Elimina archivos o directorios de un servidor remoto.
|
||||
- **sftp_create:** Crea nuevos archivos en un servidor SFTP remoto.
|
||||
- **sftp_mkdir:** Crea nuevos directorios de forma remota.
|
||||
|
||||
Consulta la documentación de la herramienta a continuación para conocer los parámetros detallados de entrada y salida para cada operación.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Sube, descarga, lista y gestiona archivos en servidores remotos a través de SFTP. Compatible con autenticación por contraseña y clave privada para transferencias seguras de archivos.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `sftp_upload`
|
||||
|
||||
Subir archivos a un servidor SFTP remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SFTP |
|
||||
| `port` | number | Sí | Puerto del servidor SFTP \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SFTP |
|
||||
| `password` | string | No | Contraseña para autenticación \(si no se usa clave privada\) |
|
||||
| `privateKey` | string | No | Clave privada para autenticación \(formato OpenSSH\) |
|
||||
| `passphrase` | string | No | Frase de contraseña para clave privada cifrada |
|
||||
| `remotePath` | string | Sí | Directorio de destino en el servidor remoto |
|
||||
| `files` | file[] | No | Archivos para subir |
|
||||
| `fileContent` | string | No | Contenido directo del archivo para subir \(para archivos de texto\) |
|
||||
| `fileName` | string | No | Nombre del archivo cuando se usa contenido directo |
|
||||
| `overwrite` | boolean | No | Si se deben sobrescribir archivos existentes \(predeterminado: true\) |
|
||||
| `permissions` | string | No | Permisos del archivo \(p. ej., 0644\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la subida fue exitosa |
|
||||
| `uploadedFiles` | json | Array de detalles de archivos subidos \(nombre, rutaRemota, tamaño\) |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `sftp_download`
|
||||
|
||||
Descargar un archivo desde un servidor SFTP remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SFTP |
|
||||
| `port` | number | Sí | Puerto del servidor SFTP \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SFTP |
|
||||
| `password` | string | No | Contraseña para autenticación \(si no se usa clave privada\) |
|
||||
| `privateKey` | string | No | Clave privada para autenticación \(formato OpenSSH\) |
|
||||
| `passphrase` | string | No | Frase de contraseña para clave privada cifrada |
|
||||
| `remotePath` | string | Sí | Ruta al archivo en el servidor remoto |
|
||||
| `encoding` | string | No | Codificación de salida: utf-8 para texto, base64 para binario \(predeterminado: utf-8\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la descarga fue exitosa |
|
||||
| `fileName` | string | Nombre del archivo descargado |
|
||||
| `content` | string | Contenido del archivo \(texto o codificado en base64\) |
|
||||
| `size` | number | Tamaño del archivo en bytes |
|
||||
| `encoding` | string | Codificación del contenido \(utf-8 o base64\) |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `sftp_list`
|
||||
|
||||
Listar archivos y directorios en un servidor SFTP remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SFTP |
|
||||
| `port` | number | Sí | Puerto del servidor SFTP \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SFTP |
|
||||
| `password` | string | No | Contraseña para autenticación \(si no se usa clave privada\) |
|
||||
| `privateKey` | string | No | Clave privada para autenticación \(formato OpenSSH\) |
|
||||
| `passphrase` | string | No | Frase de contraseña para clave privada cifrada |
|
||||
| `remotePath` | string | Sí | Ruta del directorio en el servidor remoto |
|
||||
| `detailed` | boolean | No | Incluir información detallada de archivos \(tamaño, permisos, fecha de modificación\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la operación fue exitosa |
|
||||
| `path` | string | Ruta del directorio que fue listado |
|
||||
| `entries` | json | Array de entradas del directorio con nombre, tipo, tamaño, permisos, modifiedAt |
|
||||
| `count` | number | Número de entradas en el directorio |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `sftp_delete`
|
||||
|
||||
Eliminar un archivo o directorio en un servidor SFTP remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SFTP |
|
||||
| `port` | number | Sí | Puerto del servidor SFTP \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SFTP |
|
||||
| `password` | string | No | Contraseña para autenticación \(si no se usa clave privada\) |
|
||||
| `privateKey` | string | No | Clave privada para autenticación \(formato OpenSSH\) |
|
||||
| `passphrase` | string | No | Frase de contraseña para clave privada cifrada |
|
||||
| `remotePath` | string | Sí | Ruta al archivo o directorio a eliminar |
|
||||
| `recursive` | boolean | No | Eliminar directorios recursivamente |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la eliminación fue exitosa |
|
||||
| `deletedPath` | string | Ruta que fue eliminada |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `sftp_mkdir`
|
||||
|
||||
Crear un directorio en un servidor SFTP remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SFTP |
|
||||
| `port` | number | Sí | Puerto del servidor SFTP \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SFTP |
|
||||
| `password` | string | No | Contraseña para autenticación \(si no se usa clave privada\) |
|
||||
| `privateKey` | string | No | Clave privada para autenticación \(formato OpenSSH\) |
|
||||
| `passphrase` | string | No | Frase de contraseña para clave privada cifrada |
|
||||
| `remotePath` | string | Sí | Ruta para el nuevo directorio |
|
||||
| `recursive` | boolean | No | Crear directorios principales si no existen |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si el directorio se creó correctamente |
|
||||
| `createdPath` | string | Ruta del directorio creado |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `sftp`
|
||||
@@ -35,9 +35,9 @@ Procesa un pensamiento/instrucción proporcionado, haciéndolo disponible para l
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `thought` | string | Sí | Tu razonamiento interno, análisis o proceso de pensamiento. Utiliza esto para analizar el problema paso a paso antes de responder. |
|
||||
| `thought` | string | Sí | El proceso de pensamiento o instrucción proporcionado por el usuario en el bloque de Paso de Pensamiento. |
|
||||
|
||||
#### Salida
|
||||
|
||||
|
||||
@@ -31,30 +31,37 @@ Integra Translate en el flujo de trabajo. Puede traducir texto a cualquier idiom
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `llm_chat`
|
||||
|
||||
Envía una solicitud de completado de chat a cualquier proveedor de LLM compatible
|
||||
### `openai_chat`
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `model` | string | Sí | El modelo a utilizar \(p. ej., gpt-4o, claude-sonnet-4-5, gemini-2.0-flash\) |
|
||||
| `systemPrompt` | string | No | Prompt del sistema para establecer el comportamiento del asistente |
|
||||
| `context` | string | Sí | El mensaje del usuario o contexto para enviar al modelo |
|
||||
| `apiKey` | string | No | Clave API para el proveedor \(usa la clave de la plataforma si no se proporciona para modelos alojados\) |
|
||||
| `temperature` | number | No | Temperatura para la generación de respuestas \(0-2\) |
|
||||
| `maxTokens` | number | No | Tokens máximos en la respuesta |
|
||||
| `azureEndpoint` | string | No | URL del endpoint de Azure OpenAI |
|
||||
| `azureApiVersion` | string | No | Versión de la API de Azure OpenAI |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | El contenido de la respuesta generada |
|
||||
| `model` | string | El modelo utilizado para la generación |
|
||||
| `tokens` | object | Información de uso de tokens |
|
||||
| `content` | string | Texto traducido |
|
||||
| `model` | string | Modelo utilizado |
|
||||
| `tokens` | json | Uso de tokens |
|
||||
|
||||
### `anthropic_chat`
|
||||
|
||||
### `google_chat`
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | Texto traducido |
|
||||
| `model` | string | Modelo utilizado |
|
||||
| `tokens` | json | Uso de tokens |
|
||||
|
||||
## Notas
|
||||
|
||||
|
||||
@@ -251,12 +251,12 @@ Subir un archivo multimedia (imagen, video, documento) a WordPress.com
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `file` | file | No | Archivo para subir \(objeto UserFile\) |
|
||||
| `filename` | string | No | Anulación opcional del nombre de archivo \(p. ej., imagen.jpg\) |
|
||||
| `title` | string | No | Título del medio |
|
||||
| `caption` | string | No | Leyenda del medio |
|
||||
| `file` | string | Sí | Datos del archivo codificados en Base64 o URL para obtener el archivo |
|
||||
| `filename` | string | Sí | Nombre del archivo con extensión \(p. ej., imagen.jpg\) |
|
||||
| `title` | string | No | Título del archivo multimedia |
|
||||
| `caption` | string | No | Leyenda del archivo multimedia |
|
||||
| `altText` | string | No | Texto alternativo para accesibilidad |
|
||||
| `description` | string | No | Descripción del medio |
|
||||
| `description` | string | No | Descripción del archivo multimedia |
|
||||
|
||||
#### Salida
|
||||
|
||||
|
||||
@@ -170,9 +170,28 @@ Obtener videos de una lista de reproducción de YouTube.
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array de videos en la lista de reproducción |
|
||||
|
||||
### `youtube_related_videos`
|
||||
|
||||
Encuentra videos relacionados con un video específico de YouTube.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `videoId` | string | Sí | ID del video de YouTube para encontrar videos relacionados |
|
||||
| `maxResults` | number | No | Número máximo de videos relacionados a devolver \(1-50\) |
|
||||
| `pageToken` | string | No | Token de página para paginación |
|
||||
| `apiKey` | string | Sí | Clave API de YouTube |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | Array de videos relacionados |
|
||||
|
||||
### `youtube_comments`
|
||||
|
||||
Obtener comentarios de un video de YouTube.
|
||||
Obtiene comentarios de un video de YouTube.
|
||||
|
||||
#### Entrada
|
||||
|
||||
|
||||
@@ -73,9 +73,8 @@ Recupera una lista de tickets de Zendesk con filtrado opcional
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tickets` | array | Array de objetos de ticket |
|
||||
| `paging` | object | Información de paginación |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos de los tickets |
|
||||
|
||||
### `zendesk_get_ticket`
|
||||
|
||||
@@ -94,8 +93,8 @@ Obtener un solo ticket por ID desde Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Objeto de ticket |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del ticket |
|
||||
|
||||
### `zendesk_create_ticket`
|
||||
|
||||
@@ -123,8 +122,8 @@ Crear un nuevo ticket en Zendesk con soporte para campos personalizados
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Objeto de ticket creado |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del ticket creado |
|
||||
|
||||
### `zendesk_create_tickets_bulk`
|
||||
|
||||
@@ -143,8 +142,8 @@ Crear múltiples tickets en Zendesk a la vez (máximo 100)
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Objeto de estado del trabajo |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Estado del trabajo de creación masiva |
|
||||
|
||||
### `zendesk_update_ticket`
|
||||
|
||||
@@ -172,8 +171,8 @@ Actualizar un ticket existente en Zendesk con soporte para campos personalizados
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Objeto de ticket actualizado |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos actualizados del ticket |
|
||||
|
||||
### `zendesk_update_tickets_bulk`
|
||||
|
||||
@@ -197,8 +196,8 @@ Actualizar múltiples tickets en Zendesk a la vez (máximo 100)
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Objeto de estado del trabajo |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Estado del trabajo de actualización masiva |
|
||||
|
||||
### `zendesk_delete_ticket`
|
||||
|
||||
@@ -217,8 +216,8 @@ Eliminar un ticket de Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Éxito de la eliminación |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Confirmación de eliminación |
|
||||
|
||||
### `zendesk_merge_tickets`
|
||||
|
||||
@@ -239,8 +238,8 @@ Fusionar múltiples tickets en un ticket objetivo
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Objeto de estado del trabajo |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Estado del trabajo de fusión |
|
||||
|
||||
### `zendesk_get_users`
|
||||
|
||||
@@ -262,9 +261,8 @@ Recuperar una lista de usuarios de Zendesk con filtrado opcional
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Array de objetos de usuario |
|
||||
| `paging` | object | Información de paginación |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de usuarios y metadatos |
|
||||
|
||||
### `zendesk_get_user`
|
||||
|
||||
@@ -283,8 +281,8 @@ Obtener un solo usuario por ID desde Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Objeto de usuario |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del usuario |
|
||||
|
||||
### `zendesk_get_current_user`
|
||||
|
||||
@@ -302,8 +300,8 @@ Obtener el usuario actualmente autenticado desde Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Objeto del usuario actual |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del usuario actual |
|
||||
|
||||
### `zendesk_search_users`
|
||||
|
||||
@@ -325,9 +323,8 @@ Buscar usuarios en Zendesk usando una cadena de consulta
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Array de objetos de usuario |
|
||||
| `paging` | object | Información de paginación |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Resultados de búsqueda de usuarios |
|
||||
|
||||
### `zendesk_create_user`
|
||||
|
||||
@@ -353,8 +350,8 @@ Crear un nuevo usuario en Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Objeto del usuario creado |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del usuario creado |
|
||||
|
||||
### `zendesk_create_users_bulk`
|
||||
|
||||
@@ -373,8 +370,8 @@ Crear múltiples usuarios en Zendesk mediante importación masiva
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Objeto de estado del trabajo |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Estado del trabajo de creación masiva |
|
||||
|
||||
### `zendesk_update_user`
|
||||
|
||||
@@ -401,8 +398,8 @@ Actualizar un usuario existente en Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Objeto del usuario actualizado |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos actualizados del usuario |
|
||||
|
||||
### `zendesk_update_users_bulk`
|
||||
|
||||
@@ -421,8 +418,8 @@ Actualizar múltiples usuarios en Zendesk usando actualización masiva
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Objeto de estado del trabajo |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Estado del trabajo de actualización masiva |
|
||||
|
||||
### `zendesk_delete_user`
|
||||
|
||||
@@ -441,8 +438,8 @@ Eliminar un usuario de Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Éxito de eliminación |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del usuario eliminado |
|
||||
|
||||
### `zendesk_get_organizations`
|
||||
|
||||
@@ -462,9 +459,8 @@ Obtener una lista de organizaciones de Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | Array de objetos de organización |
|
||||
| `paging` | object | Información de paginación |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos de las organizaciones |
|
||||
|
||||
### `zendesk_get_organization`
|
||||
|
||||
@@ -483,8 +479,8 @@ Obtener una única organización por ID desde Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | Objeto de organización |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de la organización |
|
||||
|
||||
### `zendesk_autocomplete_organizations`
|
||||
|
||||
@@ -505,9 +501,8 @@ Autocompletar organizaciones en Zendesk por prefijo de nombre (para coincidencia
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | Array de objetos de organización |
|
||||
| `paging` | object | Información de paginación |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Resultados de búsqueda de organizaciones |
|
||||
|
||||
### `zendesk_create_organization`
|
||||
|
||||
@@ -531,8 +526,8 @@ Crear una nueva organización en Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | Objeto de organización creada |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de la organización creada |
|
||||
|
||||
### `zendesk_create_organizations_bulk`
|
||||
|
||||
@@ -551,8 +546,8 @@ Crear múltiples organizaciones en Zendesk mediante importación masiva
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Objeto de estado del trabajo |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Estado del trabajo de creación masiva |
|
||||
|
||||
### `zendesk_update_organization`
|
||||
|
||||
@@ -577,8 +572,8 @@ Actualizar una organización existente en Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | Objeto de organización actualizada |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de la organización actualizada |
|
||||
|
||||
### `zendesk_delete_organization`
|
||||
|
||||
@@ -597,8 +592,8 @@ Eliminar una organización de Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Éxito de eliminación |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de la organización eliminada |
|
||||
|
||||
### `zendesk_search`
|
||||
|
||||
@@ -621,9 +616,8 @@ Búsqueda unificada a través de tickets, usuarios y organizaciones en Zendesk
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Array de objetos de resultado |
|
||||
| `paging` | object | Información de paginación |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Resultados de la búsqueda |
|
||||
|
||||
### `zendesk_search_count`
|
||||
|
||||
@@ -642,8 +636,8 @@ Contar el número de resultados de búsqueda que coinciden con una consulta en Z
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `count` | number | Número de resultados coincidentes |
|
||||
| `metadata` | object | Metadatos de la operación |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Resultado del recuento de búsqueda |
|
||||
|
||||
## Notas
|
||||
|
||||
|
||||
@@ -30,9 +30,6 @@ Utiliza el bloque Start para todo lo que se origina desde el editor, despliegue
|
||||
<Card title="Schedule" href="/triggers/schedule">
|
||||
Ejecución basada en cron o intervalos
|
||||
</Card>
|
||||
<Card title="RSS Feed" href="/triggers/rss">
|
||||
Monitorea feeds RSS y Atom para nuevo contenido
|
||||
</Card>
|
||||
</Cards>
|
||||
|
||||
## Comparación rápida
|
||||
@@ -42,7 +39,6 @@ Utiliza el bloque Start para todo lo que se origina desde el editor, despliegue
|
||||
| **Start** | Ejecuciones del editor, solicitudes de despliegue a API o mensajes de chat |
|
||||
| **Schedule** | Temporizador gestionado en el bloque de programación |
|
||||
| **Webhook** | Al recibir una solicitud HTTP entrante |
|
||||
| **RSS Feed** | Nuevo elemento publicado en el feed |
|
||||
|
||||
> El bloque Start siempre expone los campos `input`, `conversationId` y `files`. Añade campos personalizados al formato de entrada para datos estructurados adicionales.
|
||||
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
title: Feed RSS
|
||||
---
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { Image } from '@/components/ui/image'
|
||||
|
||||
El bloque de Feed RSS monitorea feeds RSS y Atom – cuando se publican nuevos elementos, tu flujo de trabajo se activa automáticamente.
|
||||
|
||||
<div className="flex justify-center">
|
||||
<Image
|
||||
src="/static/blocks/rss.png"
|
||||
alt="Bloque de Feed RSS"
|
||||
width={500}
|
||||
height={400}
|
||||
className="my-6"
|
||||
/>
|
||||
</div>
|
||||
|
||||
## Configuración
|
||||
|
||||
1. **Añadir bloque de Feed RSS** - Arrastra el bloque de Feed RSS para iniciar tu flujo de trabajo
|
||||
2. **Introducir URL del feed** - Pega la URL de cualquier feed RSS o Atom
|
||||
3. **Implementar** - Implementa tu flujo de trabajo para activar el sondeo
|
||||
|
||||
Una vez implementado, el feed se comprueba cada minuto en busca de nuevos elementos.
|
||||
|
||||
## Campos de salida
|
||||
|
||||
| Campo | Tipo | Descripción |
|
||||
|-------|------|-------------|
|
||||
| `title` | string | Título del elemento |
|
||||
| `link` | string | Enlace del elemento |
|
||||
| `pubDate` | string | Fecha de publicación |
|
||||
| `item` | object | Elemento en bruto con todos los campos |
|
||||
| `feed` | object | Metadatos en bruto del feed |
|
||||
|
||||
Accede a los campos mapeados directamente (`<rss.title>`) o utiliza los objetos en bruto para cualquier campo (`<rss.item.author>`, `<rss.feed.language>`).
|
||||
|
||||
## Casos de uso
|
||||
|
||||
- **Monitoreo de contenido** - Sigue blogs, sitios de noticias o actualizaciones de competidores
|
||||
- **Automatización de podcasts** - Activa flujos de trabajo cuando se publican nuevos episodios
|
||||
- **Seguimiento de lanzamientos** - Monitorea lanzamientos de GitHub, registros de cambios o actualizaciones de productos
|
||||
- **Agregación social** - Recopila contenido de plataformas que exponen feeds RSS
|
||||
|
||||
<Callout>
|
||||
Los disparadores RSS solo se activan para elementos publicados después de guardar el disparador. Los elementos existentes en el feed no se procesan.
|
||||
</Callout>
|
||||
@@ -27,16 +27,14 @@ Toutes les réponses API incluent des informations sur vos limites d'exécution
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60, // Sustained rate limit per minute
|
||||
"maxBurst": 120, // Maximum burst capacity
|
||||
"remaining": 118, // Current tokens available (up to maxBurst)
|
||||
"resetAt": "..." // When tokens next refill
|
||||
"limit": 60, // Max sync workflow executions per minute
|
||||
"remaining": 58, // Remaining sync workflow executions
|
||||
"resetAt": "..." // When the window resets
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200, // Sustained rate limit per minute
|
||||
"maxBurst": 400, // Maximum burst capacity
|
||||
"remaining": 398, // Current tokens available
|
||||
"resetAt": "..." // When tokens next refill
|
||||
"limit": 60, // Max async workflow executions per minute
|
||||
"remaining": 59, // Remaining async workflow executions
|
||||
"resetAt": "..." // When the window resets
|
||||
}
|
||||
},
|
||||
"usage": {
|
||||
@@ -48,7 +46,7 @@ Toutes les réponses API incluent des informations sur vos limites d'exécution
|
||||
}
|
||||
```
|
||||
|
||||
**Remarque :** les limites de débit utilisent un algorithme de seau à jetons. `remaining` peut dépasser `requestsPerMinute` jusqu'à `maxBurst` lorsque vous n'avez pas utilisé récemment votre allocation complète, permettant ainsi un trafic en rafale. Les limites de débit dans le corps de la réponse concernent les exécutions de workflow. Les limites de débit pour appeler ce point de terminaison API se trouvent dans les en-têtes de réponse (`X-RateLimit-*`).
|
||||
**Remarque :** Les limites de débit dans le corps de la réponse concernent les exécutions de workflow. Les limites de débit pour l'appel de ce point de terminaison API se trouvent dans les en-têtes de réponse (`X-RateLimit-*`).
|
||||
|
||||
### Interrogation des journaux
|
||||
|
||||
@@ -112,15 +110,13 @@ Interrogez les journaux d'exécution des workflows avec de nombreuses options de
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60,
|
||||
"maxBurst": 120,
|
||||
"remaining": 118,
|
||||
"limit": 60,
|
||||
"remaining": 58,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 398,
|
||||
"limit": 60,
|
||||
"remaining": 59,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
}
|
||||
},
|
||||
@@ -194,15 +190,13 @@ Récupérer des informations détaillées sur une entrée de journal spécifique
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60,
|
||||
"maxBurst": 120,
|
||||
"remaining": 118,
|
||||
"limit": 60,
|
||||
"remaining": 58,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 398,
|
||||
"limit": 60,
|
||||
"remaining": 59,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
}
|
||||
},
|
||||
@@ -488,27 +482,19 @@ Les livraisons de webhook échouées sont réessayées avec un backoff exponenti
|
||||
|
||||
## Limitation de débit
|
||||
|
||||
L'API utilise un **algorithme de seau à jetons** pour limiter le débit, offrant une utilisation équitable tout en permettant des pics de trafic :
|
||||
L'API implémente une limitation de débit pour garantir une utilisation équitable :
|
||||
|
||||
| Forfait | Requêtes/minute | Capacité de rafale |
|
||||
|------|-----------------|----------------|
|
||||
| Gratuit | 10 | 20 |
|
||||
| Pro | 30 | 60 |
|
||||
| Équipe | 60 | 120 |
|
||||
| Entreprise | 120 | 240 |
|
||||
- **Plan gratuit** : 10 requêtes par minute
|
||||
- **Plan Pro** : 30 requêtes par minute
|
||||
- **Plan Équipe** : 60 requêtes par minute
|
||||
- **Plan Entreprise** : Limites personnalisées
|
||||
|
||||
**Comment ça fonctionne :**
|
||||
- Les jetons se rechargent au rythme de `requestsPerMinute`
|
||||
- Vous pouvez accumuler jusqu'à `maxBurst` jetons en période d'inactivité
|
||||
- Chaque requête consomme 1 jeton
|
||||
- La capacité de rafale permet de gérer les pics de trafic
|
||||
Les informations de limitation de débit sont incluses dans les en-têtes de réponse :
|
||||
- `X-RateLimit-Limit` : Nombre maximum de requêtes par fenêtre
|
||||
- `X-RateLimit-Remaining` : Requêtes restantes dans la fenêtre actuelle
|
||||
- `X-RateLimit-Reset` : Horodatage ISO indiquant quand la fenêtre se réinitialise
|
||||
|
||||
Les informations sur les limites de débit sont incluses dans les en-têtes de réponse :
|
||||
- `X-RateLimit-Limit` : requêtes par minute (taux de recharge)
|
||||
- `X-RateLimit-Remaining` : jetons actuellement disponibles
|
||||
- `X-RateLimit-Reset` : horodatage ISO indiquant quand les jetons seront rechargés
|
||||
|
||||
## Exemple : interrogation pour de nouveaux journaux
|
||||
## Exemple : Polling pour nouveaux logs
|
||||
|
||||
```javascript
|
||||
let cursor = null;
|
||||
@@ -555,7 +541,7 @@ async function pollLogs() {
|
||||
setInterval(pollLogs, 30000);
|
||||
```
|
||||
|
||||
## Exemple : traitement des webhooks
|
||||
## Exemple : Traitement des webhooks
|
||||
|
||||
```javascript
|
||||
import express from 'express';
|
||||
|
||||
@@ -147,20 +147,8 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
{
|
||||
"success": true,
|
||||
"rateLimit": {
|
||||
"sync": {
|
||||
"isLimited": false,
|
||||
"requestsPerMinute": 25,
|
||||
"maxBurst": 50,
|
||||
"remaining": 50,
|
||||
"resetAt": "2025-09-08T22:51:55.999Z"
|
||||
},
|
||||
"async": {
|
||||
"isLimited": false,
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 400,
|
||||
"resetAt": "2025-09-08T22:51:56.155Z"
|
||||
},
|
||||
"sync": { "isLimited": false, "limit": 10, "remaining": 10, "resetAt": "2025-09-08T22:51:55.999Z" },
|
||||
"async": { "isLimited": false, "limit": 50, "remaining": 50, "resetAt": "2025-09-08T22:51:56.155Z" },
|
||||
"authType": "api"
|
||||
},
|
||||
"usage": {
|
||||
@@ -171,11 +159,6 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
}
|
||||
```
|
||||
|
||||
**Champs de limite de débit :**
|
||||
- `requestsPerMinute` : limite de débit soutenu (les jetons se rechargent à ce rythme)
|
||||
- `maxBurst` : nombre maximum de jetons que vous pouvez accumuler (capacité de rafale)
|
||||
- `remaining` : jetons actuellement disponibles (peut aller jusqu'à `maxBurst`)
|
||||
|
||||
**Champs de réponse :**
|
||||
- `currentPeriodCost` reflète l'utilisation dans la période de facturation actuelle
|
||||
- `limit` est dérivé des limites individuelles (Gratuit/Pro) ou des limites mutualisées de l'organisation (Équipe/Entreprise)
|
||||
@@ -205,7 +188,7 @@ Sim utilise un modèle de facturation **abonnement de base + dépassement** :
|
||||
- Exemple : 35 $ d'utilisation = 20 $ (abonnement) + 15 $ (dépassement)
|
||||
|
||||
**Forfait Équipe (40 $/siège/mois) :**
|
||||
- Utilisation mutualisée pour tous les membres de l'équipe
|
||||
- Utilisation mutualisée entre tous les membres de l'équipe
|
||||
- Dépassement calculé à partir de l'utilisation totale de l'équipe
|
||||
- Le propriétaire de l'organisation reçoit une seule facture
|
||||
|
||||
|
||||
@@ -42,15 +42,15 @@ Recherchez sur le web en utilisant Exa AI. Renvoie des résultats de recherche p
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `query` | chaîne | Oui | La requête de recherche à exécuter |
|
||||
| `numResults` | nombre | Non | Nombre de résultats à retourner \(par défaut : 10, max : 25\) |
|
||||
| `useAutoprompt` | booléen | Non | Utiliser ou non l'autoprompt pour améliorer la requête \(par défaut : false\) |
|
||||
| `useAutoprompt` | booléen | Non | Utiliser l'autoprompt pour améliorer la requête \(par défaut : false\) |
|
||||
| `type` | chaîne | Non | Type de recherche : neural, keyword, auto ou fast \(par défaut : auto\) |
|
||||
| `includeDomains` | chaîne | Non | Liste de domaines à inclure dans les résultats, séparés par des virgules |
|
||||
| `excludeDomains` | chaîne | Non | Liste de domaines à exclure des résultats, séparés par des virgules |
|
||||
| `category` | chaîne | Non | Filtrer par catégorie : company, research paper, news, pdf, github, tweet, personal site, linkedin profile, financial report |
|
||||
| `category` | chaîne | Non | Filtrer par catégorie : company, research_paper, news_article, pdf, github, tweet, movie, song, personal_site |
|
||||
| `text` | booléen | Non | Inclure le contenu textuel complet dans les résultats \(par défaut : false\) |
|
||||
| `highlights` | booléen | Non | Inclure des extraits surlignés dans les résultats \(par défaut : false\) |
|
||||
| `summary` | booléen | Non | Inclure des résumés générés par IA dans les résultats \(par défaut : false\) |
|
||||
| `livecrawl` | chaîne | Non | Mode d'exploration en direct : never \(par défaut\), fallback, always, ou preferred \(toujours essayer l'exploration en direct, revenir au cache en cas d'échec\) |
|
||||
| `livecrawl` | chaîne | Non | Mode d'exploration en direct : always, fallback, ou never \(par défaut : never\) |
|
||||
| `apiKey` | chaîne | Oui | Clé API Exa AI |
|
||||
|
||||
#### Sortie
|
||||
@@ -67,13 +67,13 @@ Récupérer le contenu des pages web en utilisant Exa AI. Renvoie le titre, le c
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `urls` | chaîne | Oui | Liste d'URLs séparées par des virgules pour récupérer le contenu |
|
||||
| `text` | booléen | Non | Si true, renvoie le texte complet de la page avec les paramètres par défaut. Si false, désactive le retour du texte. |
|
||||
| `urls` | chaîne | Oui | Liste d'URLs séparées par des virgules pour récupérer du contenu |
|
||||
| `text` | booléen | Non | Si vrai, renvoie le texte complet de la page avec les paramètres par défaut. Si faux, désactive le retour de texte. |
|
||||
| `summaryQuery` | chaîne | Non | Requête pour guider la génération du résumé |
|
||||
| `subpages` | nombre | Non | Nombre de sous-pages à explorer à partir des URLs fournies |
|
||||
| `subpageTarget` | chaîne | Non | Mots-clés séparés par des virgules pour cibler des sous-pages spécifiques \(par exemple, "docs,tutorial,about"\) |
|
||||
| `subpageTarget` | chaîne | Non | Mots-clés séparés par des virgules pour cibler des sous-pages spécifiques \(ex. : "docs,tutorial,about"\) |
|
||||
| `highlights` | booléen | Non | Inclure des extraits surlignés dans les résultats \(par défaut : false\) |
|
||||
| `livecrawl` | chaîne | Non | Mode d'exploration en direct : never \(par défaut\), fallback, always, ou preferred \(toujours essayer l'exploration en direct, revenir au cache en cas d'échec\) |
|
||||
| `livecrawl` | chaîne | Non | Mode d'exploration en direct : always, fallback, ou never \(par défaut : never\) |
|
||||
| `apiKey` | chaîne | Oui | Clé API Exa AI |
|
||||
|
||||
#### Sortie
|
||||
@@ -96,9 +96,10 @@ Trouvez des pages web similaires à une URL donnée en utilisant Exa AI. Renvoie
|
||||
| `includeDomains` | chaîne | Non | Liste de domaines à inclure dans les résultats, séparés par des virgules |
|
||||
| `excludeDomains` | chaîne | Non | Liste de domaines à exclure des résultats, séparés par des virgules |
|
||||
| `excludeSourceDomain` | booléen | Non | Exclure le domaine source des résultats \(par défaut : false\) |
|
||||
| `category` | chaîne | Non | Filtrer par catégorie : company, research_paper, news_article, pdf, github, tweet, movie, song, personal_site |
|
||||
| `highlights` | booléen | Non | Inclure des extraits surlignés dans les résultats \(par défaut : false\) |
|
||||
| `summary` | booléen | Non | Inclure des résumés générés par IA dans les résultats \(par défaut : false\) |
|
||||
| `livecrawl` | chaîne | Non | Mode d'exploration en direct : never \(par défaut\), fallback, always, ou preferred \(toujours essayer l'exploration en direct, revenir au cache en cas d'échec\) |
|
||||
| `livecrawl` | chaîne | Non | Mode d'exploration en direct : always, fallback, ou never \(par défaut : never\) |
|
||||
| `apiKey` | chaîne | Oui | Clé API Exa AI |
|
||||
|
||||
#### Sortie
|
||||
|
||||
@@ -49,8 +49,8 @@ Récupérer une liste de marchés prédictifs de Kalshi avec filtrage optionnel
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `markets` | array | Tableau d'objets de marché |
|
||||
| `paging` | object | Curseur de pagination pour récupérer plus de résultats |
|
||||
| `success` | booléen | Statut de réussite de l'opération |
|
||||
| `output` | objet | Données des marchés et métadonnées |
|
||||
|
||||
### `kalshi_get_market`
|
||||
|
||||
@@ -66,7 +66,8 @@ Récupérer les détails d'un marché prédictif spécifique par code
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `market` | object | Objet de marché avec détails |
|
||||
| `success` | booléen | Statut de réussite de l'opération |
|
||||
| `output` | objet | Données du marché et métadonnées |
|
||||
|
||||
### `kalshi_get_events`
|
||||
|
||||
@@ -86,8 +87,8 @@ Récupérer une liste d'événements de Kalshi avec filtrage optionnel
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `events` | array | Tableau d'objets d'événement |
|
||||
| `paging` | object | Curseur de pagination pour récupérer plus de résultats |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données et métadonnées des événements |
|
||||
|
||||
### `kalshi_get_event`
|
||||
|
||||
@@ -104,7 +105,8 @@ Récupérer les détails d'un événement spécifique par ticker
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | Objet d'événement avec détails |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données et métadonnées de l'événement |
|
||||
|
||||
### `kalshi_get_balance`
|
||||
|
||||
@@ -121,10 +123,8 @@ Récupérer le solde de votre compte et la valeur de votre portefeuille depuis K
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `balance` | number | Solde du compte en centimes |
|
||||
| `portfolioValue` | number | Valeur du portefeuille en centimes |
|
||||
| `balanceDollars` | number | Solde du compte en dollars |
|
||||
| `portfolioValueDollars` | number | Valeur du portefeuille en dollars |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données et métadonnées du solde |
|
||||
|
||||
### `kalshi_get_positions`
|
||||
|
||||
@@ -146,8 +146,8 @@ Récupérer vos positions ouvertes depuis Kalshi
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `positions` | array | Tableau d'objets de position |
|
||||
| `paging` | object | Curseur de pagination pour récupérer plus de résultats |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de positions et métadonnées |
|
||||
|
||||
### `kalshi_get_orders`
|
||||
|
||||
@@ -169,8 +169,8 @@ Récupérez vos ordres depuis Kalshi avec filtrage optionnel
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orders` | array | Tableau d'objets d'ordre |
|
||||
| `paging` | object | Curseur de pagination pour récupérer plus de résultats |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données des ordres et métadonnées |
|
||||
|
||||
### `kalshi_get_order`
|
||||
|
||||
@@ -188,7 +188,8 @@ Récupérer les détails d'un ordre spécifique par ID depuis Kalshi
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | Objet d'ordre avec détails |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de l'ordre |
|
||||
|
||||
### `kalshi_get_orderbook`
|
||||
|
||||
@@ -204,7 +205,8 @@ Récupérer le carnet d'ordres (offres oui et non) pour un marché spécifique
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orderbook` | objet | Carnet d'ordres avec offres et demandes oui/non |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données du carnet d'ordres et métadonnées |
|
||||
|
||||
### `kalshi_get_trades`
|
||||
|
||||
@@ -221,8 +223,8 @@ Récupérer les transactions récentes sur tous les marchés
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | tableau | Tableau d'objets de transactions |
|
||||
| `paging` | objet | Curseur de pagination pour récupérer plus de résultats |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données des transactions et métadonnées |
|
||||
|
||||
### `kalshi_get_candlesticks`
|
||||
|
||||
@@ -242,7 +244,8 @@ Récupérer les données de chandeliers OHLC pour un marché spécifique
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `candlesticks` | tableau | Tableau de données de chandeliers OHLC |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de chandeliers et métadonnées |
|
||||
|
||||
### `kalshi_get_fills`
|
||||
|
||||
@@ -265,8 +268,8 @@ Récupérer votre portefeuille
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `fills` | tableau | Tableau d'objets d'exécutions/transactions |
|
||||
| `paging` | objet | Curseur de pagination pour récupérer plus de résultats |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données et métadonnées des exécutions |
|
||||
|
||||
### `kalshi_get_series_by_ticker`
|
||||
|
||||
@@ -282,7 +285,8 @@ Récupérer les détails d'une série de marché spécifique par ticker
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | objet | Objet de série avec détails |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données et métadonnées de la série |
|
||||
|
||||
### `kalshi_get_exchange_status`
|
||||
|
||||
@@ -297,7 +301,8 @@ Récupérer le statut actuel de la plateforme d'échange Kalshi (activité de tr
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | objet | Statut de l'échange avec indicateurs trading_active et exchange_active |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données et métadonnées du statut de l'échange |
|
||||
|
||||
### `kalshi_create_order`
|
||||
|
||||
@@ -331,7 +336,8 @@ Créer un nouvel ordre sur un marché de prédiction Kalshi
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | objet | L'objet de l'ordre créé |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de l'ordre créé |
|
||||
|
||||
### `kalshi_cancel_order`
|
||||
|
||||
@@ -349,8 +355,8 @@ Annuler un ordre existant sur Kalshi
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | objet | L'objet de l'ordre annulé |
|
||||
| `reducedBy` | nombre | Nombre de contrats annulés |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de l'ordre annulé |
|
||||
|
||||
### `kalshi_amend_order`
|
||||
|
||||
@@ -378,7 +384,8 @@ Modifier le prix ou la quantité d'un ordre existant sur Kalshi
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | objet | L'objet de l'ordre modifié |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de l'ordre modifié |
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -91,11 +91,11 @@ Menez des recherches approfondies complètes sur le web en utilisant Parallel AI
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | Statut de la tâche (terminée, échouée) |
|
||||
| `status` | string | Statut de la tâche (en cours, terminée, échouée) |
|
||||
| `run_id` | string | ID unique pour cette tâche de recherche |
|
||||
| `message` | string | Message de statut |
|
||||
| `message` | string | Message de statut (pour les tâches en cours) |
|
||||
| `content` | object | Résultats de recherche (structurés selon output_schema) |
|
||||
| `basis` | array | Citations et sources avec raisonnement et niveaux de confiance |
|
||||
| `basis` | array | Citations et sources avec extraits et niveaux de confiance |
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -51,9 +51,8 @@ Générez des compléments à l'aide des modèles de chat Perplexity AI
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | Contenu de texte généré |
|
||||
| `model` | string | Modèle utilisé pour la génération |
|
||||
| `usage` | object | Informations sur l'utilisation des tokens |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Résultats du complément de chat |
|
||||
|
||||
### `perplexity_search`
|
||||
|
||||
@@ -77,7 +76,8 @@ Obtenez des résultats de recherche classés depuis Perplexity
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Tableau des résultats de recherche |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Résultats de recherche |
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -40,18 +40,19 @@ Récupérer une liste des marchés prédictifs de Polymarket avec filtrage optio
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `closed` | string | Non | Filtrer par statut fermé \(true/false\). Utiliser false pour les marchés actifs uniquement. |
|
||||
| `order` | string | Non | Champ de tri \(ex. volumeNum, liquidityNum, startDate, endDate, createdAt\) |
|
||||
| `closed` | string | Non | Filtrer par statut fermé \(true/false\). Utilisez false pour les marchés actifs uniquement. |
|
||||
| `order` | string | Non | Champ de tri \(par exemple, volumeNum, liquidityNum, startDate, endDate, createdAt\) |
|
||||
| `ascending` | string | Non | Direction de tri \(true pour ascendant, false pour descendant\) |
|
||||
| `tagId` | string | Non | Filtrer par ID de tag |
|
||||
| `limit` | string | Non | Nombre de résultats par page \(max 50\) |
|
||||
| `limit` | string | Non | Nombre de résultats par page \(recommandé : 25-50\) |
|
||||
| `offset` | string | Non | Décalage de pagination \(ignorer ce nombre de résultats\) |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `markets` | array | Tableau d'objets de marché |
|
||||
| `success` | booléen | Statut de réussite de l'opération |
|
||||
| `output` | objet | Données des marchés et métadonnées |
|
||||
|
||||
### `polymarket_get_market`
|
||||
|
||||
@@ -68,7 +69,8 @@ Récupérer les détails d'un marché prédictif spécifique par ID ou slug
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `market` | object | Objet de marché avec détails |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de marché et métadonnées |
|
||||
|
||||
### `polymarket_get_events`
|
||||
|
||||
@@ -78,18 +80,19 @@ Récupérer une liste d'événements de Polymarket avec filtrage optionnel
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `closed` | string | Non | Filtrer par statut fermé \(true/false\). Utiliser false pour les événements actifs uniquement. |
|
||||
| `order` | string | Non | Champ de tri \(ex. volume, liquidity, startDate, endDate, createdAt\) |
|
||||
| `closed` | string | Non | Filtrer par statut fermé \(true/false\). Utilisez false pour les événements actifs uniquement. |
|
||||
| `order` | string | Non | Champ de tri \(par exemple, volume, liquidity, startDate, endDate, createdAt\) |
|
||||
| `ascending` | string | Non | Direction de tri \(true pour ascendant, false pour descendant\) |
|
||||
| `tagId` | string | Non | Filtrer par ID de tag |
|
||||
| `limit` | string | Non | Nombre de résultats par page \(max 50\) |
|
||||
| `limit` | string | Non | Nombre de résultats par page \(recommandé : 25-50\) |
|
||||
| `offset` | string | Non | Décalage de pagination \(ignorer ce nombre de résultats\) |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `events` | array | Tableau d'objets d'événements |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données d'événements et métadonnées |
|
||||
|
||||
### `polymarket_get_event`
|
||||
|
||||
@@ -106,7 +109,8 @@ Récupérer les détails d'un événement spécifique par ID ou slug
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | Objet d'événement avec détails |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données et métadonnées de l'événement |
|
||||
|
||||
### `polymarket_get_tags`
|
||||
|
||||
@@ -115,15 +119,16 @@ Récupérer les tags disponibles pour filtrer les marchés sur Polymarket
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `limit` | string | Non | Nombre de résultats par page \(max 50\) |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | Non | Nombre de résultats par page \(recommandé : 25-50\) |
|
||||
| `offset` | string | Non | Décalage de pagination \(ignorer ce nombre de résultats\) |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tags` | array | Tableau d'objets de tags avec id, label et slug |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données et métadonnées des tags |
|
||||
|
||||
### `polymarket_search`
|
||||
|
||||
@@ -132,16 +137,17 @@ Rechercher des marchés, des événements et des profils sur Polymarket
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Oui | Terme de recherche |
|
||||
| `limit` | string | Non | Nombre de résultats par page \(max 50\) |
|
||||
| `offset` | string | Non | Décalage de pagination |
|
||||
| `limit` | string | Non | Nombre de résultats par page \(recommandé : 25-50\) |
|
||||
| `offset` | string | Non | Décalage de pagination \(ignorer ce nombre de résultats\) |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | object | Résultats de recherche contenant des tableaux de marchés, d'événements et de profils |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Résultats de recherche et métadonnées |
|
||||
|
||||
### `polymarket_get_series`
|
||||
|
||||
@@ -150,8 +156,8 @@ Récupérer des séries (groupes de marchés liés) depuis Polymarket
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `limit` | string | Non | Nombre de résultats par page \(max 50\) |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | Non | Nombre de résultats par page \(recommandé : 25-50\) |
|
||||
| `offset` | string | Non | Décalage de pagination \(ignorer ce nombre de résultats\) |
|
||||
|
||||
#### Sortie
|
||||
@@ -159,7 +165,7 @@ Récupérer des séries (groupes de marchés liés) depuis Polymarket
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données des séries et métadonnées |
|
||||
| `output` | object | Données et métadonnées de la série |
|
||||
|
||||
### `polymarket_get_series_by_id`
|
||||
|
||||
@@ -176,7 +182,7 @@ Récupérer une série spécifique (groupe de marché associé) par ID depuis Po
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de série et métadonnées |
|
||||
| `output` | object | Données et métadonnées de la série |
|
||||
|
||||
### `polymarket_get_orderbook`
|
||||
|
||||
@@ -193,7 +199,7 @@ Récupérer le résumé du carnet d'ordres pour un jeton spécifique
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données du carnet d'ordres et métadonnées |
|
||||
| `output` | object | Données et métadonnées du carnet d'ordres |
|
||||
|
||||
### `polymarket_get_price`
|
||||
|
||||
@@ -211,7 +217,7 @@ Récupérer le prix du marché pour un jeton et un côté spécifiques
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de prix du marché et métadonnées |
|
||||
| `output` | object | Données de prix et métadonnées |
|
||||
|
||||
### `polymarket_get_midpoint`
|
||||
|
||||
@@ -249,7 +255,7 @@ Récupérer les données historiques de prix pour un jeton de marché spécifiqu
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données d'historique des prix et métadonnées |
|
||||
| `output` | object | Données d'historique de prix et métadonnées |
|
||||
|
||||
### `polymarket_get_last_trade_price`
|
||||
|
||||
@@ -266,7 +272,7 @@ Récupérer le dernier prix de transaction pour un jeton spécifique
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données du dernier prix d'échange et métadonnées |
|
||||
| `output` | object | Dernier prix de transaction et métadonnées |
|
||||
|
||||
### `polymarket_get_spread`
|
||||
|
||||
@@ -283,7 +289,7 @@ Récupérer l'écart entre l'offre et la demande pour un jeton spécifique
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données d'écart achat-vente et métadonnées |
|
||||
| `output` | object | Données d'écart et métadonnées |
|
||||
|
||||
### `polymarket_get_tick_size`
|
||||
|
||||
@@ -300,7 +306,7 @@ Récupérer la taille minimale du tick pour un jeton spécifique
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de taille minimale de tick et métadonnées |
|
||||
| `output` | object | Taille du tick et métadonnées |
|
||||
|
||||
### `polymarket_get_positions`
|
||||
|
||||
@@ -330,14 +336,15 @@ Récupérer l'historique des transactions depuis Polymarket
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `user` | string | Non | Adresse du portefeuille de l'utilisateur pour filtrer les transactions |
|
||||
| `market` | string | Non | ID de marché pour filtrer les transactions |
|
||||
| `limit` | string | Non | Nombre de résultats par page \(max 50\) |
|
||||
| `limit` | string | Non | Nombre de résultats par page \(recommandé : 25-50\) |
|
||||
| `offset` | string | Non | Décalage de pagination \(ignorer ce nombre de résultats\) |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | array | Tableau d'objets de transactions |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données des transactions et métadonnées |
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -342,31 +342,20 @@ Supprimer un modèle d'e-mail de SendGrid
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `message` | string | Message d'état ou de réussite |
|
||||
| `messageId` | string | ID du message e-mail \(send_mail\) |
|
||||
| `to` | string | Adresse e-mail du destinataire \(send_mail\) |
|
||||
| `subject` | string | Objet de l'e-mail \(send_mail, create_template_version\) |
|
||||
| `id` | string | ID de la ressource |
|
||||
| `jobId` | string | ID de tâche pour les opérations asynchrones |
|
||||
| `email` | string | Adresse e-mail du contact |
|
||||
| `firstName` | string | Prénom du contact |
|
||||
| `lastName` | string | Nom de famille du contact |
|
||||
| `createdAt` | string | Horodatage de création |
|
||||
| `updatedAt` | string | Horodatage de dernière mise à jour |
|
||||
| `listIds` | json | Tableau des ID de listes auxquelles le contact appartient |
|
||||
| `customFields` | json | Valeurs des champs personnalisés |
|
||||
| `success` | booléen | Statut de réussite de l'opération |
|
||||
| `messageId` | chaîne | ID du message e-mail \(send_mail\) |
|
||||
| `id` | chaîne | ID de la ressource |
|
||||
| `jobId` | chaîne | ID de tâche pour les opérations asynchrones |
|
||||
| `email` | chaîne | Adresse e-mail |
|
||||
| `firstName` | chaîne | Prénom |
|
||||
| `lastName` | chaîne | Nom de famille |
|
||||
| `contacts` | json | Tableau de contacts |
|
||||
| `contactCount` | number | Nombre de contacts |
|
||||
| `contactCount` | nombre | Nombre de contacts |
|
||||
| `lists` | json | Tableau de listes |
|
||||
| `name` | string | Nom de la ressource |
|
||||
| `templates` | json | Tableau de modèles |
|
||||
| `generation` | string | Génération du modèle |
|
||||
| `versions` | json | Tableau des versions du modèle |
|
||||
| `templateId` | string | ID du modèle |
|
||||
| `active` | boolean | Si la version du modèle est active |
|
||||
| `htmlContent` | string | Contenu HTML |
|
||||
| `plainContent` | string | Contenu en texte brut |
|
||||
| `message` | chaîne | Statut ou message de réussite |
|
||||
| `name` | chaîne | Nom de la ressource |
|
||||
| `generation` | chaîne | Génération du modèle |
|
||||
|
||||
### `sendgrid_create_template_version`
|
||||
|
||||
|
||||
@@ -36,8 +36,8 @@ Traite une réflexion/instruction fournie, la rendant disponible pour les étape
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `thought` | chaîne | Oui | Votre raisonnement interne, analyse ou processus de réflexion. Utilisez ceci pour réfléchir au problème étape par étape avant de répondre. |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `thought` | chaîne | Oui | Le processus de réflexion ou l'instruction fournie par l'utilisateur dans le bloc Étape de Réflexion. |
|
||||
|
||||
#### Sortie
|
||||
|
||||
|
||||
@@ -31,30 +31,37 @@ Intégrez Translate dans le flux de travail. Peut traduire du texte dans n'impor
|
||||
|
||||
## Outils
|
||||
|
||||
### `llm_chat`
|
||||
|
||||
Envoyez une requête de complétion de chat à n'importe quel fournisseur de LLM pris en charge
|
||||
### `openai_chat`
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `model` | chaîne | Oui | Le modèle à utiliser (ex. : gpt-4o, claude-sonnet-4-5, gemini-2.0-flash) |
|
||||
| `systemPrompt` | chaîne | Non | Instruction système pour définir le comportement de l'assistant |
|
||||
| `context` | chaîne | Oui | Le message utilisateur ou le contexte à envoyer au modèle |
|
||||
| `apiKey` | chaîne | Non | Clé API pour le fournisseur (utilise la clé de plateforme si non fournie pour les modèles hébergés) |
|
||||
| `temperature` | nombre | Non | Température pour la génération de réponse (0-2) |
|
||||
| `maxTokens` | nombre | Non | Nombre maximum de tokens dans la réponse |
|
||||
| `azureEndpoint` | chaîne | Non | URL du point de terminaison Azure OpenAI |
|
||||
| `azureApiVersion` | chaîne | Non | Version de l'API Azure OpenAI |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | chaîne | Le contenu de la réponse générée |
|
||||
| `model` | chaîne | Le modèle utilisé pour la génération |
|
||||
| `tokens` | objet | Informations sur l'utilisation des tokens |
|
||||
| `content` | string | Texte traduit |
|
||||
| `model` | string | Modèle utilisé |
|
||||
| `tokens` | json | Utilisation des tokens |
|
||||
|
||||
### `anthropic_chat`
|
||||
|
||||
### `google_chat`
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | Texte traduit |
|
||||
| `model` | string | Modèle utilisé |
|
||||
| `tokens` | json | Utilisation des jetons |
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -250,13 +250,13 @@ Télécharger un fichier média (image, vidéo, document) sur WordPress.com
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | chaîne | Oui | ID du site WordPress.com ou domaine \(ex., 12345678 ou monsite.wordpress.com\) |
|
||||
| `file` | fichier | Non | Fichier à télécharger \(objet UserFile\) |
|
||||
| `filename` | chaîne | Non | Remplacement optionnel du nom de fichier \(ex., image.jpg\) |
|
||||
| `title` | chaîne | Non | Titre du média |
|
||||
| `caption` | chaîne | Non | Légende du média |
|
||||
| `altText` | chaîne | Non | Texte alternatif pour l'accessibilité |
|
||||
| `description` | chaîne | Non | Description du média |
|
||||
| `siteId` | string | Oui | ID du site WordPress.com ou domaine \(ex., 12345678 ou monsite.wordpress.com\) |
|
||||
| `file` | string | Oui | Données du fichier encodées en Base64 ou URL pour récupérer le fichier |
|
||||
| `filename` | string | Oui | Nom du fichier avec extension \(ex., image.jpg\) |
|
||||
| `title` | string | Non | Titre du média |
|
||||
| `caption` | string | Non | Légende du média |
|
||||
| `altText` | string | Non | Texte alternatif pour l'accessibilité |
|
||||
| `description` | string | Non | Description du média |
|
||||
|
||||
#### Sortie
|
||||
|
||||
|
||||
@@ -170,6 +170,25 @@ Obtenir les vidéos d'une playlist YouTube.
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | tableau | Tableau de vidéos dans la playlist |
|
||||
|
||||
### `youtube_related_videos`
|
||||
|
||||
Trouver des vidéos liées à une vidéo YouTube spécifique.
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `videoId` | chaîne | Oui | ID de la vidéo YouTube pour laquelle trouver des vidéos liées |
|
||||
| `maxResults` | nombre | Non | Nombre maximum de vidéos liées à retourner \(1-50\) |
|
||||
| `pageToken` | chaîne | Non | Jeton de page pour la pagination |
|
||||
| `apiKey` | chaîne | Oui | Clé API YouTube |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | tableau | Tableau de vidéos liées |
|
||||
|
||||
### `youtube_comments`
|
||||
|
||||
Obtenir les commentaires d'une vidéo YouTube.
|
||||
@@ -188,7 +207,7 @@ Obtenir les commentaires d'une vidéo YouTube.
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | tableau | Tableau des commentaires de la vidéo |
|
||||
| `items` | tableau | Tableau de commentaires de la vidéo |
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -74,9 +74,8 @@ Récupérer une liste de tickets depuis Zendesk avec filtrage optionnel
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tickets` | array | Tableau d'objets ticket |
|
||||
| `paging` | object | Informations de pagination |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données et métadonnées des tickets |
|
||||
|
||||
### `zendesk_get_ticket`
|
||||
|
||||
@@ -95,8 +94,8 @@ Obtenir un ticket unique par ID depuis Zendesk
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Objet ticket |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données du ticket |
|
||||
|
||||
### `zendesk_create_ticket`
|
||||
|
||||
@@ -124,8 +123,8 @@ Créer un nouveau ticket dans Zendesk avec prise en charge des champs personnali
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Objet ticket créé |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données du ticket créé |
|
||||
|
||||
### `zendesk_create_tickets_bulk`
|
||||
|
||||
@@ -144,8 +143,8 @@ Créer plusieurs tickets dans Zendesk en une seule fois (max 100)
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Objet statut de la tâche |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Statut de la tâche de création en masse |
|
||||
|
||||
### `zendesk_update_ticket`
|
||||
|
||||
@@ -173,8 +172,8 @@ Mettre à jour un ticket existant dans Zendesk avec prise en charge des champs p
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | Objet ticket mis à jour |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données du ticket mis à jour |
|
||||
|
||||
### `zendesk_update_tickets_bulk`
|
||||
|
||||
@@ -198,8 +197,8 @@ Mettre à jour plusieurs tickets dans Zendesk en une seule fois (max 100)
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Objet statut de la tâche |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Statut de la tâche de mise à jour groupée |
|
||||
|
||||
### `zendesk_delete_ticket`
|
||||
|
||||
@@ -218,8 +217,8 @@ Supprimer un ticket de Zendesk
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Succès de la suppression |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Confirmation de suppression |
|
||||
|
||||
### `zendesk_merge_tickets`
|
||||
|
||||
@@ -240,8 +239,8 @@ Fusionner plusieurs tickets dans un ticket cible
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Objet statut de la tâche |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Statut de la tâche de fusion |
|
||||
|
||||
### `zendesk_get_users`
|
||||
|
||||
@@ -263,9 +262,8 @@ Récupérer une liste d'utilisateurs de Zendesk avec filtrage optionnel
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Tableau d'objets utilisateur |
|
||||
| `paging` | object | Informations de pagination |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données utilisateurs et métadonnées |
|
||||
|
||||
### `zendesk_get_user`
|
||||
|
||||
@@ -284,8 +282,8 @@ Obtenir un utilisateur unique par ID depuis Zendesk
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Objet utilisateur |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de l'utilisateur |
|
||||
|
||||
### `zendesk_get_current_user`
|
||||
|
||||
@@ -303,8 +301,8 @@ Obtenir l'utilisateur actuellement authentifié depuis Zendesk
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Objet de l'utilisateur actuel |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de l'utilisateur actuel |
|
||||
|
||||
### `zendesk_search_users`
|
||||
|
||||
@@ -326,9 +324,8 @@ Rechercher des utilisateurs dans Zendesk à l'aide d'une chaîne de requête
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Tableau d'objets utilisateur |
|
||||
| `paging` | object | Informations de pagination |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | booléen | Statut de réussite de l'opération |
|
||||
| `output` | objet | Résultats de recherche d'utilisateurs |
|
||||
|
||||
### `zendesk_create_user`
|
||||
|
||||
@@ -354,8 +351,8 @@ Créer un nouvel utilisateur dans Zendesk
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Objet utilisateur créé |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de l'utilisateur créé |
|
||||
|
||||
### `zendesk_create_users_bulk`
|
||||
|
||||
@@ -374,8 +371,8 @@ Créer plusieurs utilisateurs dans Zendesk en utilisant l'importation en masse
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Objet d'état de la tâche |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Statut de la tâche de création en masse |
|
||||
|
||||
### `zendesk_update_user`
|
||||
|
||||
@@ -402,8 +399,8 @@ Mettre à jour un utilisateur existant dans Zendesk
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Objet utilisateur mis à jour |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données utilisateur mises à jour |
|
||||
|
||||
### `zendesk_update_users_bulk`
|
||||
|
||||
@@ -422,8 +419,8 @@ Mettre à jour plusieurs utilisateurs dans Zendesk en utilisant la mise à jour
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Objet d'état de la tâche |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Statut de la tâche de mise à jour en masse |
|
||||
|
||||
### `zendesk_delete_user`
|
||||
|
||||
@@ -442,8 +439,8 @@ Supprimer un utilisateur de Zendesk
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Succès de la suppression |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de l'utilisateur supprimé |
|
||||
|
||||
### `zendesk_get_organizations`
|
||||
|
||||
@@ -463,9 +460,8 @@ Récupérer une liste d'organisations depuis Zendesk
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | Tableau d'objets d'organisation |
|
||||
| `paging` | object | Informations de pagination |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | booléen | Statut de réussite de l'opération |
|
||||
| `output` | objet | Données et métadonnées des organisations |
|
||||
|
||||
### `zendesk_get_organization`
|
||||
|
||||
@@ -484,8 +480,8 @@ Obtenir une organisation unique par ID depuis Zendesk
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | Objet organisation |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | booléen | Statut de réussite de l'opération |
|
||||
| `output` | objet | Données de l'organisation |
|
||||
|
||||
### `zendesk_autocomplete_organizations`
|
||||
|
||||
@@ -506,9 +502,8 @@ Autocomplétion des organisations dans Zendesk par préfixe de nom (pour corresp
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | Tableau d'objets d'organisation |
|
||||
| `paging` | object | Informations de pagination |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Résultats de recherche des organisations |
|
||||
|
||||
### `zendesk_create_organization`
|
||||
|
||||
@@ -532,8 +527,8 @@ Créer une nouvelle organisation dans Zendesk
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | Objet organisation créé |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de l'organisation créée |
|
||||
|
||||
### `zendesk_create_organizations_bulk`
|
||||
|
||||
@@ -552,8 +547,8 @@ Créer plusieurs organisations dans Zendesk en utilisant l'importation en masse
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | Objet statut de la tâche |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Statut de la tâche de création en masse |
|
||||
|
||||
### `zendesk_update_organization`
|
||||
|
||||
@@ -578,8 +573,8 @@ Mettre à jour une organisation existante dans Zendesk
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | Objet organisation mis à jour |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de l'organisation mise à jour |
|
||||
|
||||
### `zendesk_delete_organization`
|
||||
|
||||
@@ -598,8 +593,8 @@ Supprimer une organisation de Zendesk
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Succès de la suppression |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Données de l'organisation supprimée |
|
||||
|
||||
### `zendesk_search`
|
||||
|
||||
@@ -622,9 +617,8 @@ Recherche unifiée à travers les tickets, utilisateurs et organisations dans Ze
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Tableau d'objets résultats |
|
||||
| `paging` | object | Informations de pagination |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Résultats de recherche |
|
||||
|
||||
### `zendesk_search_count`
|
||||
|
||||
@@ -643,8 +637,8 @@ Compter le nombre de résultats de recherche correspondant à une requête dans
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `count` | number | Nombre de résultats correspondants |
|
||||
| `metadata` | object | Métadonnées de l'opération |
|
||||
| `success` | boolean | Statut de réussite de l'opération |
|
||||
| `output` | object | Résultat du comptage de recherche |
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -21,28 +21,24 @@ import { Image } from '@/components/ui/image'
|
||||
Utilisez le bloc Démarrer pour tout ce qui provient de l'éditeur, du déploiement vers l'API ou des expériences de déploiement vers le chat. D'autres déclencheurs restent disponibles pour les flux de travail basés sur des événements :
|
||||
|
||||
<Cards>
|
||||
<Card title="Start" href="/triggers/start">
|
||||
<Card title="Démarrer" href="/triggers/start">
|
||||
Point d'entrée unifié qui prend en charge les exécutions de l'éditeur, les déploiements d'API et les déploiements de chat
|
||||
</Card>
|
||||
<Card title="Webhook" href="/triggers/webhook">
|
||||
Recevoir des charges utiles de webhook externes
|
||||
</Card>
|
||||
<Card title="Schedule" href="/triggers/schedule">
|
||||
<Card title="Planification" href="/triggers/schedule">
|
||||
Exécution basée sur cron ou intervalle
|
||||
</Card>
|
||||
<Card title="RSS Feed" href="/triggers/rss">
|
||||
Surveiller les flux RSS et Atom pour du nouveau contenu
|
||||
</Card>
|
||||
</Cards>
|
||||
|
||||
## Comparaison rapide
|
||||
|
||||
| Déclencheur | Condition de démarrage |
|
||||
|---------|-----------------|
|
||||
| **Start** | Exécutions de l'éditeur, requêtes de déploiement d'API ou messages de chat |
|
||||
| **Schedule** | Minuteur géré dans le bloc de planification |
|
||||
| **Démarrer** | Exécutions de l'éditeur, requêtes de déploiement vers l'API ou messages de chat |
|
||||
| **Planification** | Minuteur géré dans le bloc de planification |
|
||||
| **Webhook** | Sur requête HTTP entrante |
|
||||
| **RSS Feed** | Nouvel élément publié dans le flux |
|
||||
|
||||
> Le bloc Démarrer expose toujours les champs `input`, `conversationId` et `files`. Ajoutez des champs personnalisés au format d'entrée pour des données structurées supplémentaires.
|
||||
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
title: Flux RSS
|
||||
---
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { Image } from '@/components/ui/image'
|
||||
|
||||
Le bloc Flux RSS surveille les flux RSS et Atom – lorsque de nouveaux éléments sont publiés, votre workflow se déclenche automatiquement.
|
||||
|
||||
<div className="flex justify-center">
|
||||
<Image
|
||||
src="/static/blocks/rss.png"
|
||||
alt="Bloc Flux RSS"
|
||||
width={500}
|
||||
height={400}
|
||||
className="my-6"
|
||||
/>
|
||||
</div>
|
||||
|
||||
## Configuration
|
||||
|
||||
1. **Ajouter le bloc Flux RSS** - Faites glisser le bloc Flux RSS pour démarrer votre workflow
|
||||
2. **Saisir l'URL du flux** - Collez l'URL de n'importe quel flux RSS ou Atom
|
||||
3. **Déployer** - Déployez votre workflow pour activer l'interrogation
|
||||
|
||||
Une fois déployé, le flux est vérifié chaque minute pour détecter de nouveaux éléments.
|
||||
|
||||
## Champs de sortie
|
||||
|
||||
| Champ | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `title` | string | Titre de l'élément |
|
||||
| `link` | string | Lien de l'élément |
|
||||
| `pubDate` | string | Date de publication |
|
||||
| `item` | object | Élément brut avec tous les champs |
|
||||
| `feed` | object | Métadonnées brutes du flux |
|
||||
|
||||
Accédez directement aux champs mappés (`<rss.title>`) ou utilisez les objets bruts pour n'importe quel champ (`<rss.item.author>`, `<rss.feed.language>`).
|
||||
|
||||
## Cas d'utilisation
|
||||
|
||||
- **Surveillance de contenu** - Suivez les blogs, sites d'actualités ou mises à jour des concurrents
|
||||
- **Automatisation de podcast** - Déclenchez des workflows lors de la sortie de nouveaux épisodes
|
||||
- **Suivi des versions** - Surveillez les versions GitHub, les journaux de modifications ou les mises à jour de produits
|
||||
- **Agrégation sociale** - Collectez du contenu à partir de plateformes qui exposent des flux RSS
|
||||
|
||||
<Callout>
|
||||
Les déclencheurs RSS ne s'activent que pour les éléments publiés après l'enregistrement du déclencheur. Les éléments existants du flux ne sont pas traités.
|
||||
</Callout>
|
||||
@@ -27,16 +27,14 @@ SimダッシュボードのユーザーセッティングからAPIキーを生
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60, // Sustained rate limit per minute
|
||||
"maxBurst": 120, // Maximum burst capacity
|
||||
"remaining": 118, // Current tokens available (up to maxBurst)
|
||||
"resetAt": "..." // When tokens next refill
|
||||
"limit": 60, // Max sync workflow executions per minute
|
||||
"remaining": 58, // Remaining sync workflow executions
|
||||
"resetAt": "..." // When the window resets
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200, // Sustained rate limit per minute
|
||||
"maxBurst": 400, // Maximum burst capacity
|
||||
"remaining": 398, // Current tokens available
|
||||
"resetAt": "..." // When tokens next refill
|
||||
"limit": 60, // Max async workflow executions per minute
|
||||
"remaining": 59, // Remaining async workflow executions
|
||||
"resetAt": "..." // When the window resets
|
||||
}
|
||||
},
|
||||
"usage": {
|
||||
@@ -48,7 +46,7 @@ SimダッシュボードのユーザーセッティングからAPIキーを生
|
||||
}
|
||||
```
|
||||
|
||||
**注意:** レート制限はトークンバケットアルゴリズムを使用しています。最近の割り当てを完全に使用していない場合、`remaining`は`requestsPerMinute`を超えて`maxBurst`まで達することができ、バーストトラフィックを許可します。レスポンスボディのレート制限はワークフロー実行のためのものです。このAPIエンドポイントを呼び出すためのレート制限はレスポンスヘッダー(`X-RateLimit-*`)にあります。
|
||||
**注意:** レスポンス本文のレート制限はワークフロー実行に関するものです。このAPIエンドポイントを呼び出すためのレート制限はレスポンスヘッダー(`X-RateLimit-*`)にあります。
|
||||
|
||||
### ログの照会
|
||||
|
||||
@@ -112,15 +110,13 @@ SimダッシュボードのユーザーセッティングからAPIキーを生
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60,
|
||||
"maxBurst": 120,
|
||||
"remaining": 118,
|
||||
"limit": 60,
|
||||
"remaining": 58,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 398,
|
||||
"limit": 60,
|
||||
"remaining": 59,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
}
|
||||
},
|
||||
@@ -194,15 +190,13 @@ SimダッシュボードのユーザーセッティングからAPIキーを生
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60,
|
||||
"maxBurst": 120,
|
||||
"remaining": 118,
|
||||
"limit": 60,
|
||||
"remaining": 58,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 398,
|
||||
"limit": 60,
|
||||
"remaining": 59,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
}
|
||||
},
|
||||
@@ -488,25 +482,17 @@ Webhookシークレットを設定した場合、署名を検証してWebhookが
|
||||
|
||||
## レート制限
|
||||
|
||||
APIは**トークンバケットアルゴリズム**をレート制限に使用し、バーストトラフィックを許可しながら公平な使用を提供します:
|
||||
APIは公平な使用を確保するためにレート制限を実装しています:
|
||||
|
||||
| プラン | リクエスト/分 | バースト容量 |
|
||||
|------|-----------------|----------------|
|
||||
| 無料 | 10 | 20 |
|
||||
| プロ | 30 | 60 |
|
||||
| チーム | 60 | 120 |
|
||||
| エンタープライズ | 120 | 240 |
|
||||
|
||||
**仕組み:**
|
||||
- トークンは`requestsPerMinute`のレートで補充されます
|
||||
- アイドル状態のとき、最大`maxBurst`トークンまで蓄積できます
|
||||
- 各リクエストは1トークンを消費します
|
||||
- バースト容量によりトラフィックスパイクの処理が可能になります
|
||||
- **無料プラン**: 1分あたり10リクエスト
|
||||
- **プロプラン**: 1分あたり30リクエスト
|
||||
- **チームプラン**: 1分あたり60リクエスト
|
||||
- **エンタープライズプラン**: カスタム制限
|
||||
|
||||
レート制限情報はレスポンスヘッダーに含まれています:
|
||||
- `X-RateLimit-Limit`:1分あたりのリクエスト数(補充レート)
|
||||
- `X-RateLimit-Remaining`:現在利用可能なトークン
|
||||
- `X-RateLimit-Reset`:トークンが次に補充されるISOタイムスタンプ
|
||||
- `X-RateLimit-Limit`: ウィンドウあたりの最大リクエスト数
|
||||
- `X-RateLimit-Remaining`: 現在のウィンドウで残っているリクエスト数
|
||||
- `X-RateLimit-Reset`: ウィンドウがリセットされるISOタイムスタンプ
|
||||
|
||||
## 例:新しいログのポーリング
|
||||
|
||||
@@ -555,7 +541,7 @@ async function pollLogs() {
|
||||
setInterval(pollLogs, 30000);
|
||||
```
|
||||
|
||||
## 例:ウェブフックの処理
|
||||
## 例:Webhookの処理
|
||||
|
||||
```javascript
|
||||
import express from 'express';
|
||||
|
||||
@@ -147,20 +147,8 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
{
|
||||
"success": true,
|
||||
"rateLimit": {
|
||||
"sync": {
|
||||
"isLimited": false,
|
||||
"requestsPerMinute": 25,
|
||||
"maxBurst": 50,
|
||||
"remaining": 50,
|
||||
"resetAt": "2025-09-08T22:51:55.999Z"
|
||||
},
|
||||
"async": {
|
||||
"isLimited": false,
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 400,
|
||||
"resetAt": "2025-09-08T22:51:56.155Z"
|
||||
},
|
||||
"sync": { "isLimited": false, "limit": 10, "remaining": 10, "resetAt": "2025-09-08T22:51:55.999Z" },
|
||||
"async": { "isLimited": false, "limit": 50, "remaining": 50, "resetAt": "2025-09-08T22:51:56.155Z" },
|
||||
"authType": "api"
|
||||
},
|
||||
"usage": {
|
||||
@@ -171,40 +159,35 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
}
|
||||
```
|
||||
|
||||
**レート制限フィールド:**
|
||||
- `requestsPerMinute`:持続的なレート制限(トークンはこの速度で補充されます)
|
||||
- `maxBurst`:蓄積できる最大トークン数(バースト容量)
|
||||
- `remaining`:現在利用可能なトークン(最大で`maxBurst`まで)
|
||||
|
||||
**レスポンスフィールド:**
|
||||
- `currentPeriodCost`は現在の請求期間の使用状況を反映します
|
||||
- `limit`は個別の制限(無料/プロ)または組織のプール制限(チーム/エンタープライズ)から派生します
|
||||
- `plan`はユーザーに関連付けられた最優先のアクティブなプランです
|
||||
- `currentPeriodCost` は現在の請求期間の使用状況を反映します
|
||||
- `limit` は個別の制限(無料/プロ)または組織のプール制限(チーム/エンタープライズ)から導出されます
|
||||
- `plan` はユーザーに関連付けられた最優先のアクティブなプランです
|
||||
|
||||
## プラン制限
|
||||
|
||||
サブスクリプションプランによって使用制限が異なります:
|
||||
異なるサブスクリプションプランには異なる使用制限があります:
|
||||
|
||||
| プラン | 月間使用制限 | レート制限(分あたり) |
|
||||
|------|-------------------|-------------------------|
|
||||
| **無料** | $10 | 5同期、10非同期 |
|
||||
| **プロ** | $100 | 10同期、50非同期 |
|
||||
| **チーム** | $500(プール) | 50同期、100非同期 |
|
||||
| **無料** | $10 | 5 同期、10 非同期 |
|
||||
| **プロ** | $100 | 10 同期、50 非同期 |
|
||||
| **チーム** | $500(プール) | 50 同期、100 非同期 |
|
||||
| **エンタープライズ** | カスタム | カスタム |
|
||||
|
||||
## 課金モデル
|
||||
|
||||
Simは**基本サブスクリプション+超過分**の課金モデルを使用しています:
|
||||
Simは**基本サブスクリプション + 超過分**の課金モデルを使用しています:
|
||||
|
||||
### 仕組み
|
||||
|
||||
**プロプラン(月額$20):**
|
||||
- 月額サブスクリプションには$20分の使用量が含まれます
|
||||
- 使用量が$20未満 → 追加料金なし
|
||||
- 使用量が$20を超える → 月末に超過分を支払い
|
||||
- 使用量が$20を超える → 月末に超過分を支払う
|
||||
- 例:$35の使用量 = $20(サブスクリプション)+ $15(超過分)
|
||||
|
||||
**チームプラン(席あたり月額$40):**
|
||||
**チームプラン(月額$40/シート):**
|
||||
- チームメンバー全体でプールされた使用量
|
||||
- チーム全体の使用量から超過分を計算
|
||||
- 組織のオーナーが一括で請求を受ける
|
||||
@@ -226,10 +209,10 @@ Simは**基本サブスクリプション+超過分**の課金モデルを使用
|
||||
|
||||
## コスト管理のベストプラクティス
|
||||
|
||||
1. **定期的な監視**: 予期せぬ事態を避けるため、使用状況ダッシュボードを頻繁に確認する
|
||||
1. **定期的な監視**: 予想外の事態を避けるため、使用状況ダッシュボードを頻繁に確認する
|
||||
2. **予算の設定**: プランの制限を支出のガードレールとして使用する
|
||||
3. **ワークフローの最適化**: コストの高い実行を見直し、プロンプトやモデル選択を最適化する
|
||||
4. **適切なモデルの使用**: タスクの要件にモデルの複雑さを合わせる
|
||||
4. **適切なモデルの使用**: タスクの要件に合わせてモデルの複雑さを調整する
|
||||
5. **類似タスクのバッチ処理**: 可能な場合は複数のリクエストを組み合わせてオーバーヘッドを削減する
|
||||
|
||||
## 次のステップ
|
||||
|
||||
@@ -46,11 +46,11 @@ Exa AIを使用してウェブを検索します。タイトル、URL、テキ
|
||||
| `type` | string | いいえ | 検索タイプ:neural、keyword、auto、またはfast(デフォルト:auto) |
|
||||
| `includeDomains` | string | いいえ | 結果に含めるドメインのカンマ区切りリスト |
|
||||
| `excludeDomains` | string | いいえ | 結果から除外するドメインのカンマ区切りリスト |
|
||||
| `category` | string | いいえ | カテゴリによるフィルタリング:company、research paper、news、pdf、github、tweet、personal site、linkedin profile、financial report |
|
||||
| `category` | string | いいえ | カテゴリによるフィルタリング:company、research_paper、news_article、pdf、github、tweet、movie、song、personal_site |
|
||||
| `text` | boolean | いいえ | 結果に全文コンテンツを含める(デフォルト:false) |
|
||||
| `highlights` | boolean | いいえ | 結果にハイライトされたスニペットを含める(デフォルト:false) |
|
||||
| `summary` | boolean | いいえ | 結果にAI生成の要約を含める(デフォルト:false) |
|
||||
| `livecrawl` | string | いいえ | ライブクロールモード:never(デフォルト)、fallback、always、またはpreferred(常にライブクロールを試み、失敗した場合はキャッシュにフォールバック) |
|
||||
| `livecrawl` | string | いいえ | ライブクロールモード:always、fallback、またはnever(デフォルト:never) |
|
||||
| `apiKey` | string | はい | Exa AI APIキー |
|
||||
|
||||
#### 出力
|
||||
@@ -68,12 +68,12 @@ Exa AIを使用してウェブページのコンテンツを取得します。
|
||||
| パラメータ | 型 | 必須 | 説明 |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `urls` | string | はい | コンテンツを取得するURLのカンマ区切りリスト |
|
||||
| `text` | boolean | いいえ | trueの場合、デフォルト設定で完全なページテキストを返します。falseの場合、テキスト返却を無効にします。 |
|
||||
| `text` | boolean | いいえ | trueの場合、デフォルト設定でページ全文を返します。falseの場合、テキスト返却を無効にします。 |
|
||||
| `summaryQuery` | string | いいえ | 要約生成をガイドするクエリ |
|
||||
| `subpages` | number | いいえ | 提供されたURLからクロールするサブページの数 |
|
||||
| `subpageTarget` | string | いいえ | 特定のサブページをターゲットにするためのカンマ区切りキーワード(例:"docs,tutorial,about") |
|
||||
| `subpageTarget` | string | いいえ | 特定のサブページを対象とするカンマ区切りのキーワード(例:"docs,tutorial,about") |
|
||||
| `highlights` | boolean | いいえ | 結果にハイライトされたスニペットを含める(デフォルト:false) |
|
||||
| `livecrawl` | string | いいえ | ライブクロールモード:never(デフォルト)、fallback、always、またはpreferred(常にライブクロールを試み、失敗した場合はキャッシュにフォールバック) |
|
||||
| `livecrawl` | string | いいえ | ライブクロールモード:always、fallback、またはnever(デフォルト:never) |
|
||||
| `apiKey` | string | はい | Exa AI APIキー |
|
||||
|
||||
#### 出力
|
||||
@@ -96,9 +96,10 @@ Exa AIを使用して、指定されたURLに類似したウェブページを
|
||||
| `includeDomains` | string | いいえ | 結果に含めるドメインのカンマ区切りリスト |
|
||||
| `excludeDomains` | string | いいえ | 結果から除外するドメインのカンマ区切りリスト |
|
||||
| `excludeSourceDomain` | boolean | いいえ | 結果からソースドメインを除外する(デフォルト:false) |
|
||||
| `category` | string | いいえ | カテゴリによるフィルタリング:company、research_paper、news_article、pdf、github、tweet、movie、song、personal_site |
|
||||
| `highlights` | boolean | いいえ | 結果にハイライトされたスニペットを含める(デフォルト:false) |
|
||||
| `summary` | boolean | いいえ | 結果にAI生成の要約を含める(デフォルト:false) |
|
||||
| `livecrawl` | string | いいえ | ライブクロールモード:never(デフォルト)、fallback、always、またはpreferred(常にライブクロールを試み、失敗した場合はキャッシュにフォールバック) |
|
||||
| `livecrawl` | string | いいえ | ライブクロールモード:always、fallback、またはnever(デフォルト:never) |
|
||||
| `apiKey` | string | はい | Exa AI APIキー |
|
||||
|
||||
#### 出力
|
||||
|
||||
@@ -49,8 +49,8 @@ Kalshiの予測市場をワークフローに統合します。市場一覧、
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `markets` | array | 市場オブジェクトの配列 |
|
||||
| `paging` | object | さらに結果を取得するためのページネーションカーソル |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 市場データとメタデータ |
|
||||
|
||||
### `kalshi_get_market`
|
||||
|
||||
@@ -66,7 +66,8 @@ Kalshiの予測市場をワークフローに統合します。市場一覧、
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `market` | object | 詳細情報を含む市場オブジェクト |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 市場データとメタデータ |
|
||||
|
||||
### `kalshi_get_events`
|
||||
|
||||
@@ -86,8 +87,8 @@ Kalshiの予測市場をワークフローに統合します。市場一覧、
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `events` | array | イベントオブジェクトの配列 |
|
||||
| `paging` | object | さらに結果を取得するためのページネーションカーソル |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | イベントデータとメタデータ |
|
||||
|
||||
### `kalshi_get_event`
|
||||
|
||||
@@ -104,7 +105,8 @@ Kalshiの予測市場をワークフローに統合します。市場一覧、
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | 詳細情報を含むイベントオブジェクト |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | イベントデータとメタデータ |
|
||||
|
||||
### `kalshi_get_balance`
|
||||
|
||||
@@ -121,10 +123,8 @@ Kalshiからアカウント残高とポートフォリオ価値を取得
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `balance` | number | セント単位のアカウント残高 |
|
||||
| `portfolioValue` | number | セント単位のポートフォリオ価値 |
|
||||
| `balanceDollars` | number | ドル単位のアカウント残高 |
|
||||
| `portfolioValueDollars` | number | ドル単位のポートフォリオ価値 |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 残高データとメタデータ |
|
||||
|
||||
### `kalshi_get_positions`
|
||||
|
||||
@@ -146,8 +146,8 @@ Kalshiからオープンポジションを取得
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `positions` | array | ポジションオブジェクトの配列 |
|
||||
| `paging` | object | さらに結果を取得するためのページネーションカーソル |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | ポジションデータとメタデータ |
|
||||
|
||||
### `kalshi_get_orders`
|
||||
|
||||
@@ -169,8 +169,8 @@ Kalshiからオープンポジションを取得
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orders` | array | 注文オブジェクトの配列 |
|
||||
| `paging` | object | さらに結果を取得するためのページネーションカーソル |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 注文データとメタデータ |
|
||||
|
||||
### `kalshi_get_order`
|
||||
|
||||
@@ -188,7 +188,8 @@ IDを指定してKalshiから特定の注文の詳細を取得する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | 詳細情報を含む注文オブジェクト |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 注文データ |
|
||||
|
||||
### `kalshi_get_orderbook`
|
||||
|
||||
@@ -204,7 +205,8 @@ IDを指定してKalshiから特定の注文の詳細を取得する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orderbook` | object | yes/noの買い注文と売り注文を含むオーダーブック |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 注文板データとメタデータ |
|
||||
|
||||
### `kalshi_get_trades`
|
||||
|
||||
@@ -221,8 +223,8 @@ IDを指定してKalshiから特定の注文の詳細を取得する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | array | 取引オブジェクトの配列 |
|
||||
| `paging` | object | さらに結果を取得するためのページネーションカーソル |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 取引データとメタデータ |
|
||||
|
||||
### `kalshi_get_candlesticks`
|
||||
|
||||
@@ -242,7 +244,8 @@ IDを指定してKalshiから特定の注文の詳細を取得する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `candlesticks` | array | OHLC(始値・高値・安値・終値)ローソク足データの配列 |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | ローソク足データとメタデータ |
|
||||
|
||||
### `kalshi_get_fills`
|
||||
|
||||
@@ -265,8 +268,8 @@ IDを指定してKalshiから特定の注文の詳細を取得する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `fills` | array | 約定/取引オブジェクトの配列 |
|
||||
| `paging` | object | さらに結果を取得するためのページネーションカーソル |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 約定データとメタデータ |
|
||||
|
||||
### `kalshi_get_series_by_ticker`
|
||||
|
||||
@@ -282,7 +285,8 @@ IDを指定してKalshiから特定の注文の詳細を取得する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | object | 詳細を含むシリーズオブジェクト |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | シリーズデータとメタデータ |
|
||||
|
||||
### `kalshi_get_exchange_status`
|
||||
|
||||
@@ -297,7 +301,8 @@ Kalshi取引所の現在のステータス(取引と取引所のアクティ
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | object | trading_activeとexchange_activeフラグを含む取引所ステータス |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 取引所ステータスデータとメタデータ |
|
||||
|
||||
### `kalshi_create_order`
|
||||
|
||||
@@ -331,7 +336,8 @@ Kalshi予測市場に新しい注文を作成する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | 作成された注文オブジェクト |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 作成された注文データ |
|
||||
|
||||
### `kalshi_cancel_order`
|
||||
|
||||
@@ -349,8 +355,8 @@ Kalshiで既存の注文をキャンセルする
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | キャンセルされた注文オブジェクト |
|
||||
| `reducedBy` | number | キャンセルされた契約数 |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | キャンセルされた注文データ |
|
||||
|
||||
### `kalshi_amend_order`
|
||||
|
||||
@@ -378,7 +384,8 @@ Kalshiで既存の注文の価格または数量を変更する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | 変更された注文オブジェクト |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 変更された注文データ |
|
||||
|
||||
## 注意事項
|
||||
|
||||
|
||||
@@ -91,11 +91,11 @@ Parallel AIを使用してウェブ全体で包括的な詳細調査を実施し
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | タスクのステータス(完了、失敗) |
|
||||
| `status` | string | タスクのステータス(実行中、完了、失敗) |
|
||||
| `run_id` | string | この調査タスクの一意のID |
|
||||
| `message` | string | ステータスメッセージ |
|
||||
| `message` | string | ステータスメッセージ(実行中のタスク用) |
|
||||
| `content` | object | 調査結果(output_schemaに基づいて構造化) |
|
||||
| `basis` | array | 引用と情報源(根拠と信頼度レベルを含む) |
|
||||
| `basis` | array | 引用と情報源(抜粋と信頼度レベルを含む) |
|
||||
|
||||
## 注意事項
|
||||
|
||||
|
||||
@@ -51,9 +51,8 @@ Perplexity AIチャットモデルを使用して文章を生成する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | 生成されたテキストコンテンツ |
|
||||
| `model` | string | 生成に使用されたモデル |
|
||||
| `usage` | object | トークン使用情報 |
|
||||
| `success` | boolean | 操作の成功ステータス |
|
||||
| `output` | object | チャット生成結果 |
|
||||
|
||||
### `perplexity_search`
|
||||
|
||||
@@ -77,7 +76,8 @@ Perplexityからランク付けされた検索結果を取得する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | 検索結果の配列 |
|
||||
| `success` | boolean | 操作の成功ステータス |
|
||||
| `output` | object | 検索結果 |
|
||||
|
||||
## 注意事項
|
||||
|
||||
|
||||
@@ -40,11 +40,11 @@ Polymarketから予測市場のリストをオプションのフィルタリン
|
||||
|
||||
| パラメータ | 型 | 必須 | 説明 |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `closed` | string | いいえ | クローズ状態でフィルタリング(true/false)。アクティブな市場のみの場合はfalseを使用。 |
|
||||
| `closed` | string | いいえ | クローズ状態でフィルタリング(true/false)。アクティブなマーケットのみの場合はfalseを使用。 |
|
||||
| `order` | string | いいえ | ソートフィールド(例:volumeNum、liquidityNum、startDate、endDate、createdAt) |
|
||||
| `ascending` | string | いいえ | ソート方向(昇順の場合はtrue、降順の場合はfalse) |
|
||||
| `tagId` | string | いいえ | タグIDでフィルタリング |
|
||||
| `limit` | string | いいえ | ページあたりの結果数(最大50) |
|
||||
| `limit` | string | いいえ | ページあたりの結果数(推奨:25-50) |
|
||||
| `offset` | string | いいえ | ページネーションオフセット(この数の結果をスキップ) |
|
||||
|
||||
#### 出力
|
||||
@@ -84,7 +84,7 @@ Polymarketからイベントのリストを取得し、オプションでフィ
|
||||
| `order` | string | いいえ | ソートフィールド(例:volume、liquidity、startDate、endDate、createdAt) |
|
||||
| `ascending` | string | いいえ | ソート方向(昇順の場合はtrue、降順の場合はfalse) |
|
||||
| `tagId` | string | いいえ | タグIDでフィルタリング |
|
||||
| `limit` | string | いいえ | ページあたりの結果数(最大50) |
|
||||
| `limit` | string | いいえ | ページあたりの結果数(推奨:25-50) |
|
||||
| `offset` | string | いいえ | ページネーションオフセット(この数の結果をスキップ) |
|
||||
|
||||
#### 出力
|
||||
@@ -120,7 +120,7 @@ Polymarketからマーケットのフィルタリング用の利用可能なタ
|
||||
|
||||
| パラメータ | 型 | 必須 | 説明 |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | いいえ | ページあたりの結果数(最大50) |
|
||||
| `limit` | string | いいえ | ページあたりの結果数(推奨:25-50) |
|
||||
| `offset` | string | いいえ | ページネーションオフセット(この数の結果をスキップ) |
|
||||
|
||||
#### 出力
|
||||
@@ -139,15 +139,15 @@ Polymarketでマーケット、イベント、プロフィールを検索する
|
||||
| パラメータ | 型 | 必須 | 説明 |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | はい | 検索クエリ用語 |
|
||||
| `limit` | string | いいえ | ページあたりの結果数(最大50) |
|
||||
| `offset` | string | いいえ | ページネーションオフセット |
|
||||
| `limit` | string | いいえ | ページあたりの結果数(推奨:25-50) |
|
||||
| `offset` | string | いいえ | ページネーションオフセット(この数の結果をスキップ) |
|
||||
|
||||
#### 出力
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 検索結果データとメタデータ |
|
||||
| `output` | object | 検索結果とメタデータ |
|
||||
|
||||
### `polymarket_get_series`
|
||||
|
||||
@@ -157,7 +157,7 @@ Polymarketからシリーズ(関連するマーケットグループ)を取
|
||||
|
||||
| パラメータ | 型 | 必須 | 説明 |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | いいえ | ページあたりの結果数(最大50) |
|
||||
| `limit` | string | いいえ | ページあたりの結果数(推奨:25-50) |
|
||||
| `offset` | string | いいえ | ページネーションオフセット(この数の結果をスキップ) |
|
||||
|
||||
#### 出力
|
||||
@@ -199,7 +199,7 @@ PolymarketからIDで特定のシリーズ(関連する市場グループ)
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 注文台帳データとメタデータ |
|
||||
| `output` | object | オーダーブックデータとメタデータ |
|
||||
|
||||
### `polymarket_get_price`
|
||||
|
||||
@@ -217,7 +217,7 @@ PolymarketからIDで特定のシリーズ(関連する市場グループ)
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 市場価格データとメタデータ |
|
||||
| `output` | object | 価格データとメタデータ |
|
||||
|
||||
### `polymarket_get_midpoint`
|
||||
|
||||
@@ -272,7 +272,7 @@ PolymarketからIDで特定のシリーズ(関連する市場グループ)
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 最終取引価格データとメタデータ |
|
||||
| `output` | object | 最終取引価格とメタデータ |
|
||||
|
||||
### `polymarket_get_spread`
|
||||
|
||||
@@ -306,7 +306,7 @@ PolymarketからIDで特定のシリーズ(関連する市場グループ)
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 最小ティックサイズデータとメタデータ |
|
||||
| `output` | object | ティックサイズとメタデータ |
|
||||
|
||||
### `polymarket_get_positions`
|
||||
|
||||
@@ -336,14 +336,15 @@ Polymarketから取引履歴を取得する
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `user` | string | いいえ | 取引をフィルタリングするユーザーウォレットアドレス |
|
||||
| `market` | string | いいえ | 取引をフィルタリングするマーケットID |
|
||||
| `limit` | string | いいえ | ページあたりの結果数(最大50) |
|
||||
| `limit` | string | いいえ | ページあたりの結果数(推奨:25-50) |
|
||||
| `offset` | string | いいえ | ページネーションオフセット(この数の結果をスキップ) |
|
||||
|
||||
#### 出力
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | array | 取引オブジェクトの配列 |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 取引データとメタデータ |
|
||||
|
||||
## 注意事項
|
||||
|
||||
|
||||
@@ -342,30 +342,19 @@ SendGridからメールテンプレートを削除する
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `message` | string | ステータスまたは成功メッセージ |
|
||||
| `messageId` | string | メールメッセージID \(send_mail\) |
|
||||
| `to` | string | 受信者のメールアドレス \(send_mail\) |
|
||||
| `subject` | string | メールの件名 \(send_mail, create_template_version\) |
|
||||
| `messageId` | string | メールメッセージID(send_mail) |
|
||||
| `id` | string | リソースID |
|
||||
| `jobId` | string | 非同期操作用のジョブID |
|
||||
| `email` | string | 連絡先のメールアドレス |
|
||||
| `firstName` | string | 連絡先の名 |
|
||||
| `lastName` | string | 連絡先の姓 |
|
||||
| `createdAt` | string | 作成タイムスタンプ |
|
||||
| `updatedAt` | string | 最終更新タイムスタンプ |
|
||||
| `listIds` | json | 連絡先が所属するリストIDの配列 |
|
||||
| `customFields` | json | カスタムフィールドの値 |
|
||||
| `jobId` | string | 非同期操作のジョブID |
|
||||
| `email` | string | メールアドレス |
|
||||
| `firstName` | string | 名 |
|
||||
| `lastName` | string | 姓 |
|
||||
| `contacts` | json | 連絡先の配列 |
|
||||
| `contactCount` | number | 連絡先の数 |
|
||||
| `lists` | json | リストの配列 |
|
||||
| `name` | string | リソース名 |
|
||||
| `templates` | json | テンプレートの配列 |
|
||||
| `generation` | string | テンプレート世代 |
|
||||
| `versions` | json | テンプレートバージョンの配列 |
|
||||
| `templateId` | string | テンプレートID |
|
||||
| `active` | boolean | テンプレートバージョンがアクティブかどうか |
|
||||
| `htmlContent` | string | HTML内容 |
|
||||
| `plainContent` | string | プレーンテキスト内容 |
|
||||
| `message` | string | ステータスまたは成功メッセージ |
|
||||
| `name` | string | リソース名 |
|
||||
| `generation` | string | テンプレート生成方法 |
|
||||
|
||||
### `sendgrid_create_template_version`
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ Simでは、思考ツールによってエージェントがこのような意
|
||||
|
||||
| パラメータ | 型 | 必須 | 説明 |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `thought` | string | はい | あなたの内部的な推論、分析、または思考プロセス。これを使用して、応答する前に問題を段階的に考えてください。 |
|
||||
| `thought` | string | はい | 思考ステップブロックでユーザーが提供した思考プロセスまたは指示。 |
|
||||
|
||||
#### 出力
|
||||
|
||||
|
||||
@@ -31,32 +31,39 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
## ツール
|
||||
|
||||
### `llm_chat`
|
||||
|
||||
サポートされている任意のLLMプロバイダーにチャット完了リクエストを送信する
|
||||
### `openai_chat`
|
||||
|
||||
#### 入力
|
||||
|
||||
| パラメータ | 型 | 必須 | 説明 |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `model` | string | はい | 使用するモデル(例:gpt-4o、claude-sonnet-4-5、gemini-2.0-flash) |
|
||||
| `systemPrompt` | string | いいえ | アシスタントの動作を設定するシステムプロンプト |
|
||||
| `context` | string | はい | モデルに送信するユーザーメッセージまたはコンテキスト |
|
||||
| `apiKey` | string | いいえ | プロバイダーのAPIキー(ホストされたモデルの場合、提供されなければプラットフォームキーを使用) |
|
||||
| `temperature` | number | いいえ | レスポンス生成の温度(0-2) |
|
||||
| `maxTokens` | number | いいえ | レスポンスの最大トークン数 |
|
||||
| `azureEndpoint` | string | いいえ | Azure OpenAIエンドポイントURL |
|
||||
| `azureApiVersion` | string | いいえ | Azure OpenAI APIバージョン |
|
||||
|
||||
#### 出力
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | 生成されたレスポンスの内容 |
|
||||
| `model` | string | 生成に使用されたモデル |
|
||||
| `tokens` | object | トークン使用情報 |
|
||||
| `content` | string | 翻訳されたテキスト |
|
||||
| `model` | string | 使用されたモデル |
|
||||
| `tokens` | json | トークン使用量 |
|
||||
|
||||
## 注意事項
|
||||
### `anthropic_chat`
|
||||
|
||||
### `google_chat`
|
||||
|
||||
#### 入力
|
||||
|
||||
| パラメータ | 型 | 必須 | 説明 |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### 出力
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | 翻訳されたテキスト |
|
||||
| `model` | string | 使用されたモデル |
|
||||
| `tokens` | json | トークン使用量 |
|
||||
|
||||
## メモ
|
||||
|
||||
- カテゴリー: `tools`
|
||||
- タイプ: `translate`
|
||||
|
||||
@@ -251,10 +251,10 @@ IDによってWordPress.comから単一のページを取得する
|
||||
| パラメータ | 型 | 必須 | 説明 |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | はい | WordPress.comのサイトIDまたはドメイン \(例:12345678またはmysite.wordpress.com\) |
|
||||
| `file` | file | いいえ | アップロードするファイル(UserFileオブジェクト) |
|
||||
| `filename` | string | いいえ | オプションのファイル名上書き(例:image.jpg) |
|
||||
| `title` | string | いいえ | メディアタイトル |
|
||||
| `caption` | string | いいえ | メディアキャプション |
|
||||
| `file` | string | はい | Base64エンコードされたファイルデータまたはファイルを取得するURL |
|
||||
| `filename` | string | はい | 拡張子付きのファイル名 \(例:image.jpg\) |
|
||||
| `title` | string | いいえ | メディアのタイトル |
|
||||
| `caption` | string | いいえ | メディアのキャプション |
|
||||
| `altText` | string | いいえ | アクセシビリティのための代替テキスト |
|
||||
| `description` | string | いいえ | メディアの説明 |
|
||||
|
||||
|
||||
@@ -170,6 +170,25 @@ YouTube再生リストから動画を取得します。
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | プレイリスト内の動画の配列 |
|
||||
|
||||
### `youtube_related_videos`
|
||||
|
||||
特定のYouTube動画に関連する動画を検索します。
|
||||
|
||||
#### 入力
|
||||
|
||||
| パラメータ | 型 | 必須 | 説明 |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `videoId` | string | はい | 関連動画を検索するYouTube動画ID |
|
||||
| `maxResults` | number | いいえ | 返す関連動画の最大数(1-50) |
|
||||
| `pageToken` | string | いいえ | ページネーション用のページトークン |
|
||||
| `apiKey` | string | はい | YouTube APIキー |
|
||||
|
||||
#### 出力
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | 関連動画の配列 |
|
||||
|
||||
### `youtube_comments`
|
||||
|
||||
YouTube動画からコメントを取得します。
|
||||
@@ -180,7 +199,7 @@ YouTube動画からコメントを取得します。
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `videoId` | string | はい | YouTube動画ID |
|
||||
| `maxResults` | number | いいえ | 返すコメントの最大数 |
|
||||
| `order` | string | いいえ | コメントの並び順:time(時間順)またはrelevance(関連性順) |
|
||||
| `order` | string | いいえ | コメントの並び順:timeまたはrelevance |
|
||||
| `pageToken` | string | いいえ | ページネーション用のページトークン |
|
||||
| `apiKey` | string | はい | YouTube APIキー |
|
||||
|
||||
@@ -192,5 +211,5 @@ YouTube動画からコメントを取得します。
|
||||
|
||||
## 注意事項
|
||||
|
||||
- カテゴリ: `tools`
|
||||
- カテゴリー: `tools`
|
||||
- タイプ: `youtube`
|
||||
|
||||
@@ -73,9 +73,8 @@ Zendeskをワークフローに統合します。チケットの取得、チケ
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tickets` | array | チケットオブジェクトの配列 |
|
||||
| `paging` | object | ページネーション情報 |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | チケットデータとメタデータ |
|
||||
|
||||
### `zendesk_get_ticket`
|
||||
|
||||
@@ -94,8 +93,8 @@ IDによってZendeskから単一のチケットを取得
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | チケットオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | チケットデータ |
|
||||
|
||||
### `zendesk_create_ticket`
|
||||
|
||||
@@ -123,8 +122,8 @@ IDによってZendeskから単一のチケットを取得
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | 作成されたチケットオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 作成されたチケットデータ |
|
||||
|
||||
### `zendesk_create_tickets_bulk`
|
||||
|
||||
@@ -143,8 +142,8 @@ Zendeskで一度に複数のチケットを作成(最大100件)
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | ジョブステータスオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 一括作成ジョブステータス |
|
||||
|
||||
### `zendesk_update_ticket`
|
||||
|
||||
@@ -172,8 +171,8 @@ Zendeskで一度に複数のチケットを作成(最大100件)
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ticket` | object | 更新されたチケットオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 更新されたチケットデータ |
|
||||
|
||||
### `zendesk_update_tickets_bulk`
|
||||
|
||||
@@ -197,8 +196,8 @@ Zendeskで複数のチケットを一度に更新(最大100件)
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | ジョブステータスオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 一括更新ジョブのステータス |
|
||||
|
||||
### `zendesk_delete_ticket`
|
||||
|
||||
@@ -217,8 +216,8 @@ Zendeskからチケットを削除
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | 削除成功 |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 削除確認 |
|
||||
|
||||
### `zendesk_merge_tickets`
|
||||
|
||||
@@ -239,8 +238,8 @@ Zendeskからチケットを削除
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | ジョブステータスオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 統合ジョブステータス |
|
||||
|
||||
### `zendesk_get_users`
|
||||
|
||||
@@ -262,9 +261,8 @@ Zendeskからチケットを削除
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | ユーザーオブジェクトの配列 |
|
||||
| `paging` | object | ページネーション情報 |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | ユーザーデータとメタデータ |
|
||||
|
||||
### `zendesk_get_user`
|
||||
|
||||
@@ -283,8 +281,8 @@ ZendeskからIDで単一のユーザーを取得
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | ユーザーオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | ユーザーデータ |
|
||||
|
||||
### `zendesk_get_current_user`
|
||||
|
||||
@@ -302,8 +300,8 @@ Zendeskから現在認証されているユーザーを取得
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | 現在のユーザーオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 現在のユーザーデータ |
|
||||
|
||||
### `zendesk_search_users`
|
||||
|
||||
@@ -325,9 +323,8 @@ Zendeskから現在認証されているユーザーを取得
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | ユーザーオブジェクトの配列 |
|
||||
| `paging` | object | ページネーション情報 |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | ユーザー検索結果 |
|
||||
|
||||
### `zendesk_create_user`
|
||||
|
||||
@@ -353,8 +350,8 @@ Zendeskに新しいユーザーを作成する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | 作成されたユーザーオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 作成されたユーザーデータ |
|
||||
|
||||
### `zendesk_create_users_bulk`
|
||||
|
||||
@@ -373,8 +370,8 @@ Zendeskに新しいユーザーを作成する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | ジョブステータスオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 一括作成ジョブのステータス |
|
||||
|
||||
### `zendesk_update_user`
|
||||
|
||||
@@ -401,8 +398,8 @@ Zendeskの既存ユーザーを更新する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | 更新されたユーザーオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 更新されたユーザーデータ |
|
||||
|
||||
### `zendesk_update_users_bulk`
|
||||
|
||||
@@ -421,8 +418,8 @@ Zendeskの既存ユーザーを更新する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | ジョブステータスオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 一括更新ジョブステータス |
|
||||
|
||||
### `zendesk_delete_user`
|
||||
|
||||
@@ -441,8 +438,8 @@ Zendeskからユーザーを削除する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | 削除成功 |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 削除されたユーザーデータ |
|
||||
|
||||
### `zendesk_get_organizations`
|
||||
|
||||
@@ -462,9 +459,8 @@ Zendeskから組織のリストを取得する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | 組織オブジェクトの配列 |
|
||||
| `paging` | object | ページネーション情報 |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 組織データとメタデータ |
|
||||
|
||||
### `zendesk_get_organization`
|
||||
|
||||
@@ -483,8 +479,8 @@ ZendeskからIDで単一の組織を取得する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | 組織オブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 組織データ |
|
||||
|
||||
### `zendesk_autocomplete_organizations`
|
||||
|
||||
@@ -505,9 +501,8 @@ ZendeskからIDで単一の組織を取得する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organizations` | array | 組織オブジェクトの配列 |
|
||||
| `paging` | object | ページネーション情報 |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 組織検索結果 |
|
||||
|
||||
### `zendesk_create_organization`
|
||||
|
||||
@@ -531,8 +526,8 @@ Zendeskで新しい組織を作成する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | 作成された組織オブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 作成された組織データ |
|
||||
|
||||
### `zendesk_create_organizations_bulk`
|
||||
|
||||
@@ -551,8 +546,8 @@ Zendeskで新しい組織を作成する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobStatus` | object | ジョブステータスオブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 一括作成ジョブステータス |
|
||||
|
||||
### `zendesk_update_organization`
|
||||
|
||||
@@ -577,8 +572,8 @@ Zendeskで既存の組織を更新する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `organization` | object | 更新された組織オブジェクト |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 更新された組織データ |
|
||||
|
||||
### `zendesk_delete_organization`
|
||||
|
||||
@@ -597,8 +592,8 @@ Zendeskから組織を削除する
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | 削除成功 |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 削除された組織データ |
|
||||
|
||||
### `zendesk_search`
|
||||
|
||||
@@ -621,9 +616,8 @@ Zendeskでチケット、ユーザー、組織を横断した統合検索
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | 結果オブジェクトの配列 |
|
||||
| `paging` | object | ページネーション情報 |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 検索結果 |
|
||||
|
||||
### `zendesk_search_count`
|
||||
|
||||
@@ -642,8 +636,8 @@ Zendeskでクエリに一致する検索結果の数をカウント
|
||||
|
||||
| パラメータ | 型 | 説明 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `count` | number | 一致する結果の数 |
|
||||
| `metadata` | object | 操作メタデータ |
|
||||
| `success` | boolean | 操作成功ステータス |
|
||||
| `output` | object | 検索カウント結果 |
|
||||
|
||||
## 注意事項
|
||||
|
||||
|
||||
@@ -21,28 +21,24 @@ import { Image } from '@/components/ui/image'
|
||||
エディタ、APIへのデプロイ、またはチャットへのデプロイエクスペリエンスから始まるすべてのものにはスタートブロックを使用します。イベント駆動型ワークフローには他のトリガーも利用可能です:
|
||||
|
||||
<Cards>
|
||||
<Card title="Start" href="/triggers/start">
|
||||
<Card title="スタート" href="/triggers/start">
|
||||
エディタ実行、APIデプロイメント、チャットデプロイメントをサポートする統合エントリーポイント
|
||||
</Card>
|
||||
<Card title="Webhook" href="/triggers/webhook">
|
||||
外部のwebhookペイロードを受信
|
||||
<Card title="ウェブフック" href="/triggers/webhook">
|
||||
外部ウェブフックペイロードを受信
|
||||
</Card>
|
||||
<Card title="Schedule" href="/triggers/schedule">
|
||||
<Card title="スケジュール" href="/triggers/schedule">
|
||||
Cronまたは間隔ベースの実行
|
||||
</Card>
|
||||
<Card title="RSS Feed" href="/triggers/rss">
|
||||
新しいコンテンツのRSSとAtomフィードを監視
|
||||
</Card>
|
||||
</Cards>
|
||||
|
||||
## クイック比較
|
||||
|
||||
| トリガー | 開始条件 |
|
||||
|---------|-----------------|
|
||||
| **Start** | エディタ実行、APIへのデプロイリクエスト、またはチャットメッセージ |
|
||||
| **Schedule** | スケジュールブロックで管理されるタイマー |
|
||||
| **Webhook** | 受信HTTPリクエスト時 |
|
||||
| **RSS Feed** | フィードに新しいアイテムが公開された時 |
|
||||
| **スタート** | エディタ実行、APIへのデプロイリクエスト、またはチャットメッセージ |
|
||||
| **スケジュール** | スケジュールブロックで管理されるタイマー |
|
||||
| **ウェブフック** | 受信HTTPリクエスト時 |
|
||||
|
||||
> スタートブロックは常に `input`、`conversationId`、および `files` フィールドを公開します。追加の構造化データには入力フォーマットにカスタムフィールドを追加してください。
|
||||
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
title: RSSフィード
|
||||
---
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { Image } from '@/components/ui/image'
|
||||
|
||||
RSSフィードブロックはRSSとAtomフィードを監視します - 新しいアイテムが公開されると、ワークフローが自動的にトリガーされます。
|
||||
|
||||
<div className="flex justify-center">
|
||||
<Image
|
||||
src="/static/blocks/rss.png"
|
||||
alt="RSSフィードブロック"
|
||||
width={500}
|
||||
height={400}
|
||||
className="my-6"
|
||||
/>
|
||||
</div>
|
||||
|
||||
## 設定
|
||||
|
||||
1. **RSSフィードブロックを追加** - RSSフィードブロックをドラッグしてワークフローを開始
|
||||
2. **フィードURLを入力** - 任意のRSSまたはAtomフィードのURLを貼り付け
|
||||
3. **デプロイ** - ワークフローをデプロイしてポーリングを有効化
|
||||
|
||||
デプロイ後、フィードは1分ごとに新しいアイテムをチェックします。
|
||||
|
||||
## 出力フィールド
|
||||
|
||||
| フィールド | 型 | 説明 |
|
||||
|-------|------|-------------|
|
||||
| `title` | string | アイテムのタイトル |
|
||||
| `link` | string | アイテムのリンク |
|
||||
| `pubDate` | string | 公開日 |
|
||||
| `item` | object | すべてのフィールドを含む生のアイテム |
|
||||
| `feed` | object | 生のフィードメタデータ |
|
||||
|
||||
マッピングされたフィールドに直接アクセスするか(`<rss.title>`)、任意のフィールドに生のオブジェクトを使用します(`<rss.item.author>`、`<rss.feed.language>`)。
|
||||
|
||||
## ユースケース
|
||||
|
||||
- **コンテンツ監視** - ブログ、ニュースサイト、または競合他社の更新を追跡
|
||||
- **ポッドキャスト自動化** - 新しいエピソードが公開されたときにワークフローをトリガー
|
||||
- **リリース追跡** - GitHubリリース、変更ログ、または製品アップデートを監視
|
||||
- **ソーシャルアグリゲーション** - RSSフィードを公開しているプラットフォームからコンテンツを収集
|
||||
|
||||
<Callout>
|
||||
RSSトリガーは、トリガーを保存した後に公開されたアイテムに対してのみ実行されます。既存のフィードアイテムは処理されません。
|
||||
</Callout>
|
||||
@@ -27,16 +27,14 @@ curl -H "x-api-key: YOUR_API_KEY" \
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60, // Sustained rate limit per minute
|
||||
"maxBurst": 120, // Maximum burst capacity
|
||||
"remaining": 118, // Current tokens available (up to maxBurst)
|
||||
"resetAt": "..." // When tokens next refill
|
||||
"limit": 60, // Max sync workflow executions per minute
|
||||
"remaining": 58, // Remaining sync workflow executions
|
||||
"resetAt": "..." // When the window resets
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200, // Sustained rate limit per minute
|
||||
"maxBurst": 400, // Maximum burst capacity
|
||||
"remaining": 398, // Current tokens available
|
||||
"resetAt": "..." // When tokens next refill
|
||||
"limit": 60, // Max async workflow executions per minute
|
||||
"remaining": 59, // Remaining async workflow executions
|
||||
"resetAt": "..." // When the window resets
|
||||
}
|
||||
},
|
||||
"usage": {
|
||||
@@ -48,7 +46,7 @@ curl -H "x-api-key: YOUR_API_KEY" \
|
||||
}
|
||||
```
|
||||
|
||||
**注意:** 速率限制使用令牌桶算法。`remaining` 可以超过 `requestsPerMinute` 达到 `maxBurst`,当您最近未使用全部配额时,允许突发流量。响应正文中的速率限制适用于工作流执行。调用此 API 端点的速率限制在响应头中(`X-RateLimit-*`)。
|
||||
**注意:** 响应正文中的速率限制是针对工作流执行的。调用此 API 端点的速率限制在响应标头中(`X-RateLimit-*`)。
|
||||
|
||||
### 查询日志
|
||||
|
||||
@@ -112,15 +110,13 @@ curl -H "x-api-key: YOUR_API_KEY" \
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60,
|
||||
"maxBurst": 120,
|
||||
"remaining": 118,
|
||||
"limit": 60,
|
||||
"remaining": 58,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 398,
|
||||
"limit": 60,
|
||||
"remaining": 59,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
}
|
||||
},
|
||||
@@ -194,15 +190,13 @@ curl -H "x-api-key: YOUR_API_KEY" \
|
||||
"limits": {
|
||||
"workflowExecutionRateLimit": {
|
||||
"sync": {
|
||||
"requestsPerMinute": 60,
|
||||
"maxBurst": 120,
|
||||
"remaining": 118,
|
||||
"limit": 60,
|
||||
"remaining": 58,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
},
|
||||
"async": {
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 398,
|
||||
"limit": 60,
|
||||
"remaining": 59,
|
||||
"resetAt": "2025-01-01T12:35:56.789Z"
|
||||
}
|
||||
},
|
||||
@@ -488,25 +482,17 @@ curl -H "x-api-key: YOUR_API_KEY" \
|
||||
|
||||
## 速率限制
|
||||
|
||||
该 API 使用 **令牌桶算法** 进行速率限制,在提供公平使用的同时允许突发流量:
|
||||
API 实现了速率限制以确保公平使用:
|
||||
|
||||
| 计划 | 请求/分钟 | 突发容量 |
|
||||
|------|-----------|----------|
|
||||
| 免费 | 10 | 20 |
|
||||
| 专业版 | 30 | 60 |
|
||||
| 团队版 | 60 | 120 |
|
||||
| 企业版 | 120 | 240 |
|
||||
- **免费计划**:每分钟 10 次请求
|
||||
- **专业计划**:每分钟 30 次请求
|
||||
- **团队计划**:每分钟 60 次请求
|
||||
- **企业计划**:自定义限制
|
||||
|
||||
**工作原理:**
|
||||
- 令牌以 `requestsPerMinute` 的速率补充
|
||||
- 空闲时最多可累积 `maxBurst` 个令牌
|
||||
- 每个请求消耗 1 个令牌
|
||||
- 突发容量允许处理流量高峰
|
||||
|
||||
速率限制信息包含在响应头中:
|
||||
- `X-RateLimit-Limit`:每分钟请求数(补充速率)
|
||||
- `X-RateLimit-Remaining`:当前可用令牌数
|
||||
- `X-RateLimit-Reset`:令牌下次补充的 ISO 时间戳
|
||||
速率限制信息包含在响应标头中:
|
||||
- `X-RateLimit-Limit`:每个窗口的最大请求数
|
||||
- `X-RateLimit-Remaining`:当前窗口中剩余的请求数
|
||||
- `X-RateLimit-Reset`:窗口重置时的 ISO 时间戳
|
||||
|
||||
## 示例:轮询新日志
|
||||
|
||||
@@ -555,7 +541,7 @@ async function pollLogs() {
|
||||
setInterval(pollLogs, 30000);
|
||||
```
|
||||
|
||||
## 示例:处理 Webhooks
|
||||
## 示例:处理 Webhook
|
||||
|
||||
```javascript
|
||||
import express from 'express';
|
||||
|
||||
@@ -147,20 +147,8 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
{
|
||||
"success": true,
|
||||
"rateLimit": {
|
||||
"sync": {
|
||||
"isLimited": false,
|
||||
"requestsPerMinute": 25,
|
||||
"maxBurst": 50,
|
||||
"remaining": 50,
|
||||
"resetAt": "2025-09-08T22:51:55.999Z"
|
||||
},
|
||||
"async": {
|
||||
"isLimited": false,
|
||||
"requestsPerMinute": 200,
|
||||
"maxBurst": 400,
|
||||
"remaining": 400,
|
||||
"resetAt": "2025-09-08T22:51:56.155Z"
|
||||
},
|
||||
"sync": { "isLimited": false, "limit": 10, "remaining": 10, "resetAt": "2025-09-08T22:51:55.999Z" },
|
||||
"async": { "isLimited": false, "limit": 50, "remaining": 50, "resetAt": "2025-09-08T22:51:56.155Z" },
|
||||
"authType": "api"
|
||||
},
|
||||
"usage": {
|
||||
@@ -171,11 +159,6 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
}
|
||||
```
|
||||
|
||||
**速率限制字段:**
|
||||
- `requestsPerMinute`:持续速率限制(令牌以此速率补充)
|
||||
- `maxBurst`:您可以累积的最大令牌数(突发容量)
|
||||
- `remaining`:当前可用令牌数(最多可达 `maxBurst`)
|
||||
|
||||
**响应字段:**
|
||||
- `currentPeriodCost` 反映当前计费周期的使用情况
|
||||
- `limit` 来源于个人限制(免费/专业)或组织池限制(团队/企业)
|
||||
@@ -187,9 +170,9 @@ curl -X GET -H "X-API-Key: YOUR_API_KEY" -H "Content-Type: application/json" htt
|
||||
|
||||
| 计划 | 每月使用限制 | 速率限制(每分钟) |
|
||||
|------|-------------------|-------------------------|
|
||||
| **免费** | $10 | 5 同步,10 异步 |
|
||||
| **专业** | $100 | 10 同步,50 异步 |
|
||||
| **团队** | $500(共享) | 50 同步,100 异步 |
|
||||
| **免费** | $10 | 5 同步, 10 异步 |
|
||||
| **专业** | $100 | 10 同步, 50 异步 |
|
||||
| **团队** | $500(共享) | 50 同步, 100 异步 |
|
||||
| **企业** | 自定义 | 自定义 |
|
||||
|
||||
## 计费模式
|
||||
@@ -204,9 +187,9 @@ Sim 使用 **基础订阅 + 超额** 的计费模式:
|
||||
- 使用超过 $20 → 月底支付超额部分
|
||||
- 示例:$35 使用 = $20(订阅)+ $15(超额)
|
||||
|
||||
**团队计划($40/每席位/月):**
|
||||
- 团队成员之间共享使用额度
|
||||
- 超额费用根据团队总使用量计算
|
||||
**团队计划($40/人/月):**
|
||||
- 团队成员共享使用额度
|
||||
- 超额部分根据团队总使用量计算
|
||||
- 组织所有者收到一张账单
|
||||
|
||||
**企业计划:**
|
||||
@@ -215,20 +198,20 @@ Sim 使用 **基础订阅 + 超额** 的计费模式:
|
||||
|
||||
### 阈值计费
|
||||
|
||||
当未计费的超额费用达到 $50 时,Sim 会自动计费全额未计费金额。
|
||||
当未结算的超额费用达到 $50 时,Sim 会自动结算全部未结算金额。
|
||||
|
||||
**示例:**
|
||||
- 第 10 天:$70 超额 → 立即计费 $70
|
||||
- 第 15 天:额外使用 $35(总计 $105)→ 已计费,无需操作
|
||||
- 第 20 天:再使用 $50(总计 $155,未计费 $85)→ 立即计费 $85
|
||||
- 第 10 天:$70 超额 → 立即结算 $70
|
||||
- 第 15 天:额外使用 $35(总计 $105)→ 已结算,无需操作
|
||||
- 第 20 天:再使用 $50(总计 $155,未结算 $85)→ 立即结算 $85
|
||||
|
||||
这会将大量的超额费用分散到整个月,而不是在周期结束时收到一张大账单。
|
||||
这将把大量的超额费用分散到整个月,而不是在周期结束时收到一张大账单。
|
||||
|
||||
## 成本管理最佳实践
|
||||
|
||||
1. **定期监控**:经常检查您的使用仪表板,避免意外情况
|
||||
2. **设定预算**:使用计划限制作为支出控制的护栏
|
||||
3. **优化工作流程**:审查高成本的执行操作,优化提示或模型选择
|
||||
3. **优化工作流程**:审查高成本的执行情况,优化提示或模型选择
|
||||
4. **使用合适的模型**:根据任务需求匹配模型复杂度
|
||||
5. **批量处理相似任务**:尽可能合并多个请求以减少开销
|
||||
|
||||
|
||||
@@ -46,11 +46,11 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
| `type` | string | 否 | 搜索类型:neural、keyword、auto 或 fast \(默认值: auto\) |
|
||||
| `includeDomains` | string | 否 | 用逗号分隔的域名列表,包含在结果中 |
|
||||
| `excludeDomains` | string | 否 | 用逗号分隔的域名列表,从结果中排除 |
|
||||
| `category` | string | 否 | 按类别筛选:company、research paper、news、pdf、github、tweet、personal site、linkedin profile、financial report |
|
||||
| `category` | string | 否 | 按类别筛选:company、research_paper、news_article、pdf、github、tweet、movie、song、personal_site |
|
||||
| `text` | boolean | 否 | 在结果中包含完整文本内容 \(默认值: false\) |
|
||||
| `highlights` | boolean | 否 | 在结果中包含高亮片段 \(默认值: false\) |
|
||||
| `summary` | boolean | 否 | 在结果中包含 AI 生成的摘要 \(默认值: false\) |
|
||||
| `livecrawl` | string | 否 | 实时爬取模式:never \(默认值\)、fallback、always 或 preferred \(始终尝试实时爬取,失败时回退到缓存\) |
|
||||
| `livecrawl` | string | 否 | 实时爬取模式:always、fallback 或 never \(默认值: never\) |
|
||||
| `apiKey` | string | 是 | Exa AI API 密钥 |
|
||||
|
||||
#### 输出
|
||||
@@ -67,13 +67,13 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 必需 | 描述 |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `urls` | string | 是 | 用逗号分隔的 URL 列表,用于检索内容 |
|
||||
| `text` | boolean | 否 | 如果为 true,则返回具有默认设置的完整页面文本。如果为 false,则禁用文本返回。 |
|
||||
| `urls` | string | 是 | 用逗号分隔的 URL 列表,用于获取内容 |
|
||||
| `text` | boolean | 否 | 如果为 true,则返回默认设置的完整页面文本。如果为 false,则禁用文本返回。 |
|
||||
| `summaryQuery` | string | 否 | 用于指导摘要生成的查询 |
|
||||
| `subpages` | number | 否 | 从提供的 URL 中爬取的子页面数量 |
|
||||
| `subpages` | number | 否 | 从提供的 URL 爬取的子页面数量 |
|
||||
| `subpageTarget` | string | 否 | 用逗号分隔的关键字,用于定位特定子页面 \(例如:"docs,tutorial,about"\) |
|
||||
| `highlights` | boolean | 否 | 在结果中包含高亮片段 \(默认值: false\) |
|
||||
| `livecrawl` | string | 否 | 实时爬取模式:never \(默认值\)、fallback、always 或 preferred \(始终尝试实时爬取,失败时回退到缓存\) |
|
||||
| `livecrawl` | string | 否 | 实时爬取模式:always、fallback 或 never \(默认值: never\) |
|
||||
| `apiKey` | string | 是 | Exa AI API 密钥 |
|
||||
|
||||
#### 输出
|
||||
@@ -90,15 +90,16 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 必需 | 描述 |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `url` | string | 是 | 用于查找相似链接的 URL |
|
||||
| `url` | string | 是 | 要查找相似链接的 URL |
|
||||
| `numResults` | number | 否 | 要返回的相似链接数量 \(默认值: 10,最大值: 25\) |
|
||||
| `text` | boolean | 否 | 是否包含相似页面的完整文本 |
|
||||
| `includeDomains` | string | 否 | 用逗号分隔的域名列表,包含在结果中 |
|
||||
| `excludeDomains` | string | 否 | 用逗号分隔的域名列表,从结果中排除 |
|
||||
| `excludeSourceDomain` | boolean | 否 | 从结果中排除源域名 \(默认值: false\) |
|
||||
| `category` | string | 否 | 按类别筛选:company、research_paper、news_article、pdf、github、tweet、movie、song、personal_site |
|
||||
| `highlights` | boolean | 否 | 在结果中包含高亮片段 \(默认值: false\) |
|
||||
| `summary` | boolean | 否 | 在结果中包含 AI 生成的摘要 \(默认值: false\) |
|
||||
| `livecrawl` | string | 否 | 实时爬取模式:never \(默认值\), fallback, always, 或 preferred \(始终尝试实时爬取,失败时回退到缓存\) |
|
||||
| `livecrawl` | string | 否 | 实时爬取模式:always、fallback 或 never \(默认值: never\) |
|
||||
| `apiKey` | string | 是 | Exa AI API 密钥 |
|
||||
|
||||
#### 输出
|
||||
|
||||
@@ -49,8 +49,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `markets` | array | 市场对象的数组 |
|
||||
| `paging` | object | 用于获取更多结果的分页游标 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 市场数据和元数据 |
|
||||
|
||||
### `kalshi_get_market`
|
||||
|
||||
@@ -66,7 +66,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `market` | object | 包含详细信息的市场对象 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 市场数据和元数据 |
|
||||
|
||||
### `kalshi_get_events`
|
||||
|
||||
@@ -86,8 +87,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `events` | array | 事件对象的数组 |
|
||||
| `paging` | object | 用于获取更多结果的分页游标 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 事件数据和元数据 |
|
||||
|
||||
### `kalshi_get_event`
|
||||
|
||||
@@ -104,7 +105,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | 包含详细信息的事件对象 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 事件数据和元数据 |
|
||||
|
||||
### `kalshi_get_balance`
|
||||
|
||||
@@ -121,10 +123,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `balance` | number | 账户余额(以分为单位) |
|
||||
| `portfolioValue` | number | 投资组合价值(以分为单位) |
|
||||
| `balanceDollars` | number | 账户余额(以美元为单位) |
|
||||
| `portfolioValueDollars` | number | 投资组合价值(以美元为单位) |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 余额数据和元数据 |
|
||||
|
||||
### `kalshi_get_positions`
|
||||
|
||||
@@ -146,8 +146,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `positions` | array | 持仓对象的数组 |
|
||||
| `paging` | object | 用于获取更多结果的分页游标 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 位置数据和元数据 |
|
||||
|
||||
### `kalshi_get_orders`
|
||||
|
||||
@@ -169,8 +169,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orders` | array | 订单对象的数组 |
|
||||
| `paging` | object | 用于获取更多结果的分页游标 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 订单数据和元数据 |
|
||||
|
||||
### `kalshi_get_order`
|
||||
|
||||
@@ -188,7 +188,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | 包含详细信息的订单对象 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 订单数据 |
|
||||
|
||||
### `kalshi_get_orderbook`
|
||||
|
||||
@@ -204,7 +205,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orderbook` | object | 包含买入/卖出报价的订单簿 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 订单簿数据和元数据 |
|
||||
|
||||
### `kalshi_get_trades`
|
||||
|
||||
@@ -221,8 +223,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `trades` | array | 交易对象的数组 |
|
||||
| `paging` | object | 用于获取更多结果的分页游标 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 交易数据和元数据 |
|
||||
|
||||
### `kalshi_get_candlesticks`
|
||||
|
||||
@@ -242,7 +244,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `candlesticks` | array | OHLC 蜡烛图数据的数组 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 蜡烛图数据和元数据 |
|
||||
|
||||
### `kalshi_get_fills`
|
||||
|
||||
@@ -265,8 +268,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `fills` | array | 成交/交易对象的数组 |
|
||||
| `paging` | object | 用于获取更多结果的分页游标 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 填充数据和元数据 |
|
||||
|
||||
### `kalshi_get_series_by_ticker`
|
||||
|
||||
@@ -282,7 +285,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | object | 包含详细信息的系列对象 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 系列数据和元数据 |
|
||||
|
||||
### `kalshi_get_exchange_status`
|
||||
|
||||
@@ -297,7 +301,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | object | 包含 trading_active 和 exchange_active 标志的交易所状态 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 交易所状态数据和元数据 |
|
||||
|
||||
### `kalshi_create_order`
|
||||
|
||||
@@ -331,7 +336,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | 创建的订单对象 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 创建的订单数据 |
|
||||
|
||||
### `kalshi_cancel_order`
|
||||
|
||||
@@ -349,8 +355,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | 已取消的订单对象 |
|
||||
| `reducedBy` | number | 已取消的合约数量 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 已取消的订单数据 |
|
||||
|
||||
### `kalshi_amend_order`
|
||||
|
||||
@@ -378,7 +384,8 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | 修改后的订单对象 |
|
||||
| `success` | boolean | 操作成功状态 |
|
||||
| `output` | object | 修改后的订单数据 |
|
||||
|
||||
## 注意
|
||||
|
||||
|
||||
@@ -91,11 +91,11 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `status` | string | 任务状态(已完成,失败) |
|
||||
| `status` | string | 任务状态(运行中、已完成、失败) |
|
||||
| `run_id` | string | 此研究任务的唯一 ID |
|
||||
| `message` | string | 状态消息 |
|
||||
| `message` | string | 状态消息(针对运行中的任务) |
|
||||
| `content` | object | 研究结果(基于 output_schema 结构化) |
|
||||
| `basis` | array | 引用和来源,包括推理和置信度等级 |
|
||||
| `basis` | array | 引用和来源,包括摘录和置信度等级 |
|
||||
|
||||
## 注意
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user