mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-10 23:48:09 -05:00
Compare commits
75 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6cd078b0fe | ||
|
|
fb4c9827f8 | ||
|
|
4fd5f0051f | ||
|
|
002713ec4b | ||
|
|
5d6c1f7b88 | ||
|
|
7752beac01 | ||
|
|
7101dc58d4 | ||
|
|
58251e28e6 | ||
|
|
8ef9a45125 | ||
|
|
ca818a6503 | ||
|
|
1b903f2db5 | ||
|
|
414a54c358 | ||
|
|
3b9f0f9ce2 | ||
|
|
dcbdcb43aa | ||
|
|
1642ed754b | ||
|
|
d22b5783be | ||
|
|
8e7d8c93e3 | ||
|
|
ca3eb5b5a5 | ||
|
|
dc5a2b1ad1 | ||
|
|
3f84ed9b72 | ||
|
|
31874939ee | ||
|
|
b54ca604b6 | ||
|
|
e581608472 | ||
|
|
a4d4dfaa32 | ||
|
|
099e86e3c1 | ||
|
|
042de6a944 | ||
|
|
f44e7e34ec | ||
|
|
6bfb643ef8 | ||
|
|
cd5d1c0958 | ||
|
|
9df87d9b88 | ||
|
|
c864d17991 | ||
|
|
36c91f4ca9 | ||
|
|
6d4ba6d5cf | ||
|
|
5d791cd55f | ||
|
|
5630e133fd | ||
|
|
08a11935af | ||
|
|
3158b62da8 | ||
|
|
e157ce5fbc | ||
|
|
7de721e090 | ||
|
|
3e83fb398c | ||
|
|
a6e3c92c10 | ||
|
|
9670d96eca | ||
|
|
eb0d4cbd57 | ||
|
|
ffd12e1da4 | ||
|
|
84c2335a37 | ||
|
|
2ab8cec8c3 | ||
|
|
bf54c88ae4 | ||
|
|
41c068c023 | ||
|
|
6fda9bd72e | ||
|
|
3b4f227e43 | ||
|
|
0ae7eb197a | ||
|
|
304b5d9c7e | ||
|
|
ee3e1e8cf9 | ||
|
|
774e5d585c | ||
|
|
ede41af674 | ||
|
|
cb0c55c6f6 | ||
|
|
54cc93743f | ||
|
|
d22b21c8d1 | ||
|
|
8c32ad4c0d | ||
|
|
1e080e98e8 | ||
|
|
b069034d9c | ||
|
|
3a4f130f69 | ||
|
|
e80feee51f | ||
|
|
7f62467f84 | ||
|
|
7b2792122d | ||
|
|
4e9cab39c3 | ||
|
|
e3a57d30e8 | ||
|
|
f25db707d7 | ||
|
|
08d57b4f8b | ||
|
|
f56d85bda6 | ||
|
|
d7a650a355 | ||
|
|
a8f87f7e3a | ||
|
|
9330940658 | ||
|
|
fc5f815c7a | ||
|
|
7bf9251db1 |
@@ -8,7 +8,7 @@ ENSURE that you use the logger.info and logger.warn and logger.error instead of
|
||||
|
||||
## Comments
|
||||
|
||||
You must use TSDOC for comments. Do not use ==== for comments to separate sections.
|
||||
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
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
FROM oven/bun:1.2.22-alpine
|
||||
FROM oven/bun:1.3.3-alpine
|
||||
|
||||
# Install necessary packages for development
|
||||
RUN apk add --no-cache \
|
||||
|
||||
2
.github/workflows/docs-embeddings.yml
vendored
2
.github/workflows/docs-embeddings.yml
vendored
@@ -17,7 +17,7 @@ jobs:
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: 1.2.22
|
||||
bun-version: 1.3.3
|
||||
|
||||
- name: Setup Node
|
||||
uses: actions/setup-node@v4
|
||||
|
||||
4
.github/workflows/i18n.yml
vendored
4
.github/workflows/i18n.yml
vendored
@@ -26,7 +26,7 @@ jobs:
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: 1.2.22
|
||||
bun-version: 1.3.3
|
||||
|
||||
- name: Cache Bun dependencies
|
||||
uses: actions/cache@v4
|
||||
@@ -126,7 +126,7 @@ jobs:
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: 1.2.22
|
||||
bun-version: 1.3.3
|
||||
|
||||
- name: Cache Bun dependencies
|
||||
uses: actions/cache@v4
|
||||
|
||||
2
.github/workflows/migrations.yml
vendored
2
.github/workflows/migrations.yml
vendored
@@ -16,7 +16,7 @@ jobs:
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: 1.2.22
|
||||
bun-version: 1.3.3
|
||||
|
||||
- name: Cache Bun dependencies
|
||||
uses: actions/cache@v4
|
||||
|
||||
2
.github/workflows/publish-cli.yml
vendored
2
.github/workflows/publish-cli.yml
vendored
@@ -16,7 +16,7 @@ jobs:
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: 1.2.22
|
||||
bun-version: 1.3.3
|
||||
|
||||
- name: Setup Node.js for npm publishing
|
||||
uses: actions/setup-node@v4
|
||||
|
||||
2
.github/workflows/publish-ts-sdk.yml
vendored
2
.github/workflows/publish-ts-sdk.yml
vendored
@@ -16,7 +16,7 @@ jobs:
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: 1.2.22
|
||||
bun-version: 1.3.3
|
||||
|
||||
- name: Setup Node.js for npm publishing
|
||||
uses: actions/setup-node@v4
|
||||
|
||||
2
.github/workflows/test-build.yml
vendored
2
.github/workflows/test-build.yml
vendored
@@ -16,7 +16,7 @@ jobs:
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v2
|
||||
with:
|
||||
bun-version: 1.2.22
|
||||
bun-version: 1.3.3
|
||||
|
||||
- name: Setup Node
|
||||
uses: actions/setup-node@v4
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { findNeighbour } from 'fumadocs-core/server'
|
||||
import { findNeighbour } from 'fumadocs-core/page-tree'
|
||||
import defaultMdxComponents from 'fumadocs-ui/mdx'
|
||||
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from 'fumadocs-ui/page'
|
||||
import { ChevronLeft, ChevronRight } from 'lucide-react'
|
||||
@@ -186,9 +186,6 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
|
||||
footer: <TOCFooter />,
|
||||
single: false,
|
||||
}}
|
||||
article={{
|
||||
className: 'scroll-smooth max-sm:pb-16',
|
||||
}}
|
||||
tableOfContentPopover={{
|
||||
style: 'clerk',
|
||||
enabled: true,
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
'use client'
|
||||
|
||||
import { type ReactNode, useEffect, useState } from 'react'
|
||||
import type { PageTree } from 'fumadocs-core/server'
|
||||
import type { Folder, Item, Separator } from 'fumadocs-core/page-tree'
|
||||
import { ChevronRight } from 'lucide-react'
|
||||
import Link from 'next/link'
|
||||
import { usePathname } from 'next/navigation'
|
||||
@@ -11,7 +11,7 @@ function isActive(url: string, pathname: string, nested = true): boolean {
|
||||
return url === pathname || (nested && pathname.startsWith(`${url}/`))
|
||||
}
|
||||
|
||||
export function SidebarItem({ item }: { item: PageTree.Item }) {
|
||||
export function SidebarItem({ item }: { item: Item }) {
|
||||
const pathname = usePathname()
|
||||
const active = isActive(item.url, pathname, false)
|
||||
|
||||
@@ -33,15 +33,7 @@ export function SidebarItem({ item }: { item: PageTree.Item }) {
|
||||
)
|
||||
}
|
||||
|
||||
export function SidebarFolder({
|
||||
item,
|
||||
level,
|
||||
children,
|
||||
}: {
|
||||
item: PageTree.Folder
|
||||
level: number
|
||||
children: ReactNode
|
||||
}) {
|
||||
export function SidebarFolder({ item, children }: { item: Folder; children: ReactNode }) {
|
||||
const pathname = usePathname()
|
||||
const hasActiveChild = checkHasActiveChild(item, pathname)
|
||||
const [open, setOpen] = useState(hasActiveChild)
|
||||
@@ -112,7 +104,7 @@ export function SidebarFolder({
|
||||
)
|
||||
}
|
||||
|
||||
export function SidebarSeparator({ item }: { item: PageTree.Separator }) {
|
||||
export function SidebarSeparator({ item }: { item: Separator }) {
|
||||
return (
|
||||
<p className='mt-4 mb-1.5 px-2.5 font-semibold text-[10px] text-gray-500/80 uppercase tracking-wide dark:text-gray-500'>
|
||||
{item.name}
|
||||
@@ -120,7 +112,7 @@ export function SidebarSeparator({ item }: { item: PageTree.Separator }) {
|
||||
)
|
||||
}
|
||||
|
||||
function checkHasActiveChild(node: PageTree.Folder, pathname: string): boolean {
|
||||
function checkHasActiveChild(node: Folder, pathname: string): boolean {
|
||||
if (node.index && isActive(node.index.url, pathname)) {
|
||||
return true
|
||||
}
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -24,7 +24,7 @@ export function BlockInfoCard({
|
||||
<div className='flex items-center justify-center p-6'>
|
||||
<div
|
||||
className='flex h-20 w-20 items-center justify-center rounded-lg'
|
||||
style={{ backgroundColor: color }}
|
||||
style={{ background: color }}
|
||||
>
|
||||
{ResolvedIcon ? (
|
||||
<ResolvedIcon className='h-10 w-10 text-white' />
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
|
||||
import type { ComponentType, SVGProps } from 'react'
|
||||
import {
|
||||
AhrefsIcon,
|
||||
AirtableIcon,
|
||||
ApifyIcon,
|
||||
ApolloIcon,
|
||||
ArxivIcon,
|
||||
AsanaIcon,
|
||||
@@ -13,13 +15,18 @@ import {
|
||||
CalendlyIcon,
|
||||
ClayIcon,
|
||||
ConfluenceIcon,
|
||||
DatadogIcon,
|
||||
DiscordIcon,
|
||||
DocumentIcon,
|
||||
DropboxIcon,
|
||||
DynamoDBIcon,
|
||||
ElasticsearchIcon,
|
||||
ElevenLabsIcon,
|
||||
ExaAIIcon,
|
||||
EyeIcon,
|
||||
FirecrawlIcon,
|
||||
GithubIcon,
|
||||
GitLabIcon,
|
||||
GmailIcon,
|
||||
GoogleCalendarIcon,
|
||||
GoogleDocsIcon,
|
||||
@@ -28,6 +35,7 @@ import {
|
||||
GoogleIcon,
|
||||
GoogleSheetsIcon,
|
||||
GoogleVaultIcon,
|
||||
GrafanaIcon,
|
||||
HubspotIcon,
|
||||
HuggingFaceIcon,
|
||||
HunterIOIcon,
|
||||
@@ -36,9 +44,12 @@ import {
|
||||
IntercomIcon,
|
||||
JinaAIIcon,
|
||||
JiraIcon,
|
||||
KalshiIcon,
|
||||
LinearIcon,
|
||||
LinkedInIcon,
|
||||
LinkupIcon,
|
||||
MailchimpIcon,
|
||||
MailgunIcon,
|
||||
Mem0Icon,
|
||||
MicrosoftExcelIcon,
|
||||
MicrosoftOneDriveIcon,
|
||||
@@ -57,17 +68,24 @@ import {
|
||||
PerplexityIcon,
|
||||
PineconeIcon,
|
||||
PipedriveIcon,
|
||||
PolymarketIcon,
|
||||
PostgresIcon,
|
||||
PosthogIcon,
|
||||
PylonIcon,
|
||||
QdrantIcon,
|
||||
RDSIcon,
|
||||
RedditIcon,
|
||||
ResendIcon,
|
||||
S3Icon,
|
||||
SalesforceIcon,
|
||||
SearchIcon,
|
||||
SendgridIcon,
|
||||
SentryIcon,
|
||||
SerperIcon,
|
||||
ShopifyIcon,
|
||||
SlackIcon,
|
||||
SmtpIcon,
|
||||
SshIcon,
|
||||
STTIcon,
|
||||
StagehandIcon,
|
||||
StripeIcon,
|
||||
@@ -84,19 +102,23 @@ import {
|
||||
WebflowIcon,
|
||||
WhatsAppIcon,
|
||||
WikipediaIcon,
|
||||
WordpressIcon,
|
||||
xIcon,
|
||||
YouTubeIcon,
|
||||
ZendeskIcon,
|
||||
ZepIcon,
|
||||
ZoomIcon,
|
||||
} from '@/components/icons'
|
||||
|
||||
type IconComponent = ComponentType<SVGProps<SVGSVGElement>>
|
||||
|
||||
export const blockTypeToIconMap: Record<string, IconComponent> = {
|
||||
zoom: ZoomIcon,
|
||||
zep: ZepIcon,
|
||||
zendesk: ZendeskIcon,
|
||||
youtube: YouTubeIcon,
|
||||
x: xIcon,
|
||||
wordpress: WordpressIcon,
|
||||
wikipedia: WikipediaIcon,
|
||||
whatsapp: WhatsAppIcon,
|
||||
webflow: WebflowIcon,
|
||||
@@ -117,18 +139,25 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
|
||||
stripe: StripeIcon,
|
||||
stagehand_agent: StagehandIcon,
|
||||
stagehand: StagehandIcon,
|
||||
ssh: SshIcon,
|
||||
smtp: SmtpIcon,
|
||||
slack: SlackIcon,
|
||||
shopify: ShopifyIcon,
|
||||
sharepoint: MicrosoftSharepointIcon,
|
||||
serper: SerperIcon,
|
||||
sentry: SentryIcon,
|
||||
sendgrid: SendgridIcon,
|
||||
search: SearchIcon,
|
||||
salesforce: SalesforceIcon,
|
||||
s3: S3Icon,
|
||||
resend: ResendIcon,
|
||||
reddit: RedditIcon,
|
||||
rds: RDSIcon,
|
||||
qdrant: QdrantIcon,
|
||||
pylon: PylonIcon,
|
||||
posthog: PosthogIcon,
|
||||
postgresql: PostgresIcon,
|
||||
polymarket: PolymarketIcon,
|
||||
pipedrive: PipedriveIcon,
|
||||
pinecone: PineconeIcon,
|
||||
perplexity: PerplexityIcon,
|
||||
@@ -146,10 +175,13 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
|
||||
microsoft_excel: MicrosoftExcelIcon,
|
||||
memory: BrainIcon,
|
||||
mem0: Mem0Icon,
|
||||
mailgun: MailgunIcon,
|
||||
mailchimp: MailchimpIcon,
|
||||
linkup: LinkupIcon,
|
||||
linkedin: LinkedInIcon,
|
||||
linear: LinearIcon,
|
||||
knowledge: PackageSearchIcon,
|
||||
kalshi: KalshiIcon,
|
||||
jira: JiraIcon,
|
||||
jina: JinaAIIcon,
|
||||
intercom: IntercomIcon,
|
||||
@@ -158,6 +190,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
|
||||
hunter: HunterIOIcon,
|
||||
huggingface: HuggingFaceIcon,
|
||||
hubspot: HubspotIcon,
|
||||
grafana: GrafanaIcon,
|
||||
google_vault: GoogleVaultIcon,
|
||||
google_sheets: GoogleSheetsIcon,
|
||||
google_forms: GoogleFormsIcon,
|
||||
@@ -166,12 +199,17 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
|
||||
google_calendar: GoogleCalendarIcon,
|
||||
google_search: GoogleIcon,
|
||||
gmail: GmailIcon,
|
||||
gitlab: GitLabIcon,
|
||||
github: GithubIcon,
|
||||
firecrawl: FirecrawlIcon,
|
||||
file: DocumentIcon,
|
||||
exa: ExaAIIcon,
|
||||
elevenlabs: ElevenLabsIcon,
|
||||
elasticsearch: ElasticsearchIcon,
|
||||
dynamodb: DynamoDBIcon,
|
||||
dropbox: DropboxIcon,
|
||||
discord: DiscordIcon,
|
||||
datadog: DatadogIcon,
|
||||
confluence: ConfluenceIcon,
|
||||
clay: ClayIcon,
|
||||
calendly: CalendlyIcon,
|
||||
@@ -179,5 +217,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
|
||||
asana: AsanaIcon,
|
||||
arxiv: ArxivIcon,
|
||||
apollo: ApolloIcon,
|
||||
apify: ApifyIcon,
|
||||
airtable: AirtableIcon,
|
||||
ahrefs: AhrefsIcon,
|
||||
}
|
||||
|
||||
@@ -251,32 +251,78 @@ Rufen Sie Ausführungsdetails einschließlich des Workflow-Zustandsschnappschuss
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Webhook-Abonnements
|
||||
## Benachrichtigungen
|
||||
|
||||
Erhalten Sie Echtzeitbenachrichtigungen, wenn Workflow-Ausführungen abgeschlossen werden. Webhooks werden über die Sim-Benutzeroberfläche im Workflow-Editor konfiguriert.
|
||||
Erhalten Sie Echtzeit-Benachrichtigungen, wenn Workflow-Ausführungen abgeschlossen sind, per Webhook, E-Mail oder Slack. Benachrichtigungen werden auf Workspace-Ebene von der Protokollseite aus konfiguriert.
|
||||
|
||||
### Konfiguration
|
||||
|
||||
Webhooks können für jeden Workflow über die Benutzeroberfläche des Workflow-Editors konfiguriert werden. Klicken Sie auf das Webhook-Symbol in der Kontrollleiste, um Ihre Webhook-Abonnements einzurichten.
|
||||
Konfigurieren Sie Benachrichtigungen von der Protokollseite aus, indem Sie auf die Menütaste klicken und "Benachrichtigungen konfigurieren" auswählen.
|
||||
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<Video src="configure-webhook.mp4" width={700} height={450} />
|
||||
</div>
|
||||
**Benachrichtigungskanäle:**
|
||||
- **Webhook**: Senden Sie HTTP POST-Anfragen an Ihren Endpunkt
|
||||
- **E-Mail**: Erhalten Sie E-Mail-Benachrichtigungen mit Ausführungsdetails
|
||||
- **Slack**: Posten Sie Nachrichten in einen Slack-Kanal
|
||||
|
||||
**Verfügbare Konfigurationsoptionen:**
|
||||
**Workflow-Auswahl:**
|
||||
- Wählen Sie bestimmte Workflows zur Überwachung aus
|
||||
- Oder wählen Sie "Alle Workflows", um aktuelle und zukünftige Workflows einzubeziehen
|
||||
|
||||
**Filteroptionen:**
|
||||
- `levelFilter`: Zu empfangende Protokollebenen (`info`, `error`)
|
||||
- `triggerFilter`: Zu empfangende Auslösertypen (`api`, `webhook`, `schedule`, `manual`, `chat`)
|
||||
|
||||
**Optionale Daten:**
|
||||
- `includeFinalOutput`: Schließt die endgültige Ausgabe des Workflows ein
|
||||
- `includeTraceSpans`: Schließt detaillierte Ausführungs-Trace-Spans ein
|
||||
- `includeRateLimits`: Schließt Informationen zum Ratenlimit ein (Sync/Async-Limits und verbleibende)
|
||||
- `includeUsageData`: Schließt Abrechnungszeitraum-Nutzung und -Limits ein
|
||||
|
||||
### Alarmregeln
|
||||
|
||||
Anstatt Benachrichtigungen für jede Ausführung zu erhalten, konfigurieren Sie Alarmregeln, um nur bei erkannten Problemen benachrichtigt zu werden:
|
||||
|
||||
**Aufeinanderfolgende Fehler**
|
||||
- Alarm nach X aufeinanderfolgenden fehlgeschlagenen Ausführungen (z.B. 3 Fehler in Folge)
|
||||
- Wird zurückgesetzt, wenn eine Ausführung erfolgreich ist
|
||||
|
||||
**Fehlerrate**
|
||||
- Alarm, wenn die Fehlerrate X% in den letzten Y Stunden überschreitet
|
||||
- Erfordert mindestens 5 Ausführungen im Zeitfenster
|
||||
- Wird erst nach Ablauf des vollständigen Zeitfensters ausgelöst
|
||||
|
||||
**Latenz-Schwellenwert**
|
||||
- Alarm, wenn eine Ausführung länger als X Sekunden dauert
|
||||
- Nützlich zum Erkennen langsamer oder hängender Workflows
|
||||
|
||||
**Latenz-Spitze**
|
||||
- Alarm, wenn die Ausführung X% langsamer als der Durchschnitt ist
|
||||
- Vergleicht mit der durchschnittlichen Dauer über das konfigurierte Zeitfenster
|
||||
- Erfordert mindestens 5 Ausführungen, um eine Baseline zu etablieren
|
||||
|
||||
**Kostenschwelle**
|
||||
- Alarmierung, wenn eine einzelne Ausführung mehr als $X kostet
|
||||
- Nützlich, um teure LLM-Aufrufe zu erkennen
|
||||
|
||||
**Keine Aktivität**
|
||||
- Alarmierung, wenn innerhalb von X Stunden keine Ausführungen stattfinden
|
||||
- Nützlich zur Überwachung geplanter Workflows, die regelmäßig ausgeführt werden sollten
|
||||
|
||||
**Fehlerzählung**
|
||||
- Alarmierung, wenn die Fehleranzahl X innerhalb eines Zeitfensters überschreitet
|
||||
- Erfasst die Gesamtfehler, nicht aufeinanderfolgende
|
||||
|
||||
Alle Alarmtypen beinhalten eine Abklingzeit von 1 Stunde, um Benachrichtigungsspam zu vermeiden.
|
||||
|
||||
### Webhook-Konfiguration
|
||||
|
||||
Für Webhooks stehen zusätzliche Optionen zur Verfügung:
|
||||
- `url`: Ihre Webhook-Endpunkt-URL
|
||||
- `secret`: Optionales Geheimnis für die HMAC-Signaturverifizierung
|
||||
- `includeFinalOutput`: Die endgültige Ausgabe des Workflows in die Nutzlast einschließen
|
||||
- `includeTraceSpans`: Detaillierte Ausführungs-Trace-Spans einschließen
|
||||
- `includeRateLimits`: Informationen zum Ratelimit des Workflow-Besitzers einschließen
|
||||
- `includeUsageData`: Nutzungs- und Abrechnungsdaten des Workflow-Besitzers einschließen
|
||||
- `levelFilter`: Array von Log-Ebenen, die empfangen werden sollen (`info`, `error`)
|
||||
- `triggerFilter`: Array von Auslösertypen, die empfangen werden sollen (`api`, `webhook`, `schedule`, `manual`, `chat`)
|
||||
- `active`: Webhook-Abonnement aktivieren/deaktivieren
|
||||
- `secret`: Optionales Geheimnis für HMAC-Signaturverifizierung
|
||||
|
||||
### Webhook-Nutzlast
|
||||
### Payload-Struktur
|
||||
|
||||
Wenn eine Workflow-Ausführung abgeschlossen ist, sendet Sim eine POST-Anfrage an Ihre Webhook-URL:
|
||||
Wenn eine Workflow-Ausführung abgeschlossen ist, sendet Sim die folgende Payload (über Webhook POST, E-Mail oder Slack):
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -327,17 +373,17 @@ Wenn eine Workflow-Ausführung abgeschlossen ist, sendet Sim eine POST-Anfrage a
|
||||
|
||||
### Webhook-Header
|
||||
|
||||
Jede Webhook-Anfrage enthält diese Header:
|
||||
Jede Webhook-Anfrage enthält diese Header (nur Webhook-Kanal):
|
||||
|
||||
- `sim-event`: Ereignistyp (immer `workflow.execution.completed`)
|
||||
- `sim-timestamp`: Unix-Zeitstempel in Millisekunden
|
||||
- `sim-delivery-id`: Eindeutige Lieferungs-ID für Idempotenz
|
||||
- `sim-signature`: HMAC-SHA256-Signatur zur Verifizierung (falls Secret konfiguriert)
|
||||
- `Idempotency-Key`: Identisch mit der Lieferungs-ID zur Erkennung von Duplikaten
|
||||
- `sim-delivery-id`: Eindeutige Zustell-ID für Idempotenz
|
||||
- `sim-signature`: HMAC-SHA256-Signatur zur Verifizierung (falls Geheimnis konfiguriert)
|
||||
- `Idempotency-Key`: Gleich wie Zustell-ID zur Erkennung von Duplikaten
|
||||
|
||||
### Signaturverifizierung
|
||||
|
||||
Wenn Sie ein Webhook-Secret konfigurieren, überprüfen Sie die Signatur, um sicherzustellen, dass der Webhook von Sim stammt:
|
||||
Wenn Sie ein Webhook-Geheimnis konfigurieren, überprüfen Sie die Signatur, um sicherzustellen, dass der Webhook von Sim stammt:
|
||||
|
||||
<Tabs items={['Node.js', 'Python']}>
|
||||
<Tab value="Node.js">
|
||||
@@ -414,7 +460,7 @@ Fehlgeschlagene Webhook-Zustellungen werden mit exponentiellem Backoff und Jitte
|
||||
|
||||
- Maximale Versuche: 5
|
||||
- Wiederholungsverzögerungen: 5 Sekunden, 15 Sekunden, 1 Minute, 3 Minuten, 10 Minuten
|
||||
- Jitter: Bis zu 10% zusätzliche Verzögerung, um Überlastungen zu vermeiden
|
||||
- Jitter: Bis zu 10% zusätzliche Verzögerung, um Überlastung zu vermeiden
|
||||
- Nur HTTP 5xx und 429 Antworten lösen Wiederholungen aus
|
||||
- Zustellungen haben ein Timeout nach 30 Sekunden
|
||||
|
||||
@@ -424,15 +470,15 @@ Fehlgeschlagene Webhook-Zustellungen werden mit exponentiellem Backoff und Jitte
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Polling-Strategie**: Verwenden Sie beim Abfragen von Logs die cursorbasierte Paginierung mit `order=asc` und `startDate`, um neue Logs effizient abzurufen.
|
||||
1. **Polling-Strategie**: Verwende bei der Abfrage von Logs eine cursor-basierte Paginierung mit `order=asc` und `startDate`, um neue Logs effizient abzurufen.
|
||||
|
||||
2. **Webhook-Sicherheit**: Konfigurieren Sie immer ein Webhook-Secret und überprüfen Sie Signaturen, um sicherzustellen, dass Anfragen von Sim stammen.
|
||||
2. **Webhook-Sicherheit**: Konfiguriere immer ein Webhook-Secret und überprüfe Signaturen, um sicherzustellen, dass Anfragen von Sim stammen.
|
||||
|
||||
3. **Idempotenz**: Verwenden Sie den `Idempotency-Key`Header, um doppelte Webhook-Zustellungen zu erkennen und zu behandeln.
|
||||
3. **Idempotenz**: Verwende den `Idempotency-Key`Header, um doppelte Webhook-Zustellungen zu erkennen und zu behandeln.
|
||||
|
||||
4. **Datenschutz**: Standardmäßig werden `finalOutput` und `traceSpans` von den Antworten ausgeschlossen. Aktivieren Sie diese nur, wenn Sie die Daten benötigen und die Datenschutzauswirkungen verstehen.
|
||||
4. **Datenschutz**: Standardmäßig werden `finalOutput` und `traceSpans` aus den Antworten ausgeschlossen. Aktiviere diese nur, wenn du die Daten benötigst und die Datenschutzauswirkungen verstehst.
|
||||
|
||||
5. **Rate-Limiting**: Implementieren Sie exponentielles Backoff, wenn Sie 429-Antworten erhalten. Überprüfen Sie den `Retry-After`Header für die empfohlene Wartezeit.
|
||||
5. **Rate-Limiting**: Implementiere exponentielles Backoff, wenn du 429-Antworten erhältst. Überprüfe den `Retry-After`Header für die empfohlene Wartezeit.
|
||||
|
||||
## Rate-Limiting
|
||||
|
||||
@@ -443,7 +489,7 @@ Die API implementiert Rate-Limiting, um eine faire Nutzung zu gewährleisten:
|
||||
- **Team-Plan**: 60 Anfragen pro Minute
|
||||
- **Enterprise-Plan**: Individuelle Limits
|
||||
|
||||
Informationen zum Rate-Limit sind in den Antwort-Headern enthalten:
|
||||
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
|
||||
@@ -495,7 +541,7 @@ async function pollLogs() {
|
||||
setInterval(pollLogs, 30000);
|
||||
```
|
||||
|
||||
## Beispiel: Verarbeitung von Webhooks
|
||||
## Beispiel: Verarbeiten von Webhooks
|
||||
|
||||
```javascript
|
||||
import express from 'express';
|
||||
|
||||
@@ -147,4 +147,4 @@ Der Snapshot bietet:
|
||||
|
||||
- Erfahren Sie mehr über die [Kostenberechnung](/execution/costs), um die Preisgestaltung von Workflows zu verstehen
|
||||
- Erkunden Sie die [externe API](/execution/api) für programmatischen Zugriff auf Protokolle
|
||||
- Richten Sie [Webhook-Benachrichtigungen](/execution/api#webhook-subscriptions) für Echtzeit-Warnungen ein
|
||||
- Richten Sie [Benachrichtigungen](/execution/api#notifications) für Echtzeit-Warnungen per Webhook, E-Mail oder Slack ein
|
||||
199
apps/docs/content/docs/de/tools/ahrefs.mdx
Normal file
199
apps/docs/content/docs/de/tools/ahrefs.mdx
Normal file
@@ -0,0 +1,199 @@
|
||||
---
|
||||
title: Ahrefs
|
||||
description: SEO-Analyse mit Ahrefs
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="ahrefs"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Ahrefs](https://ahrefs.com/) ist ein führendes SEO-Toolset zur Analyse von Websites, Verfolgung von Rankings, Überwachung von Backlinks und Keyword-Recherche. Es bietet detaillierte Einblicke in Ihre eigene Website sowie in die Ihrer Wettbewerber und hilft Ihnen, datengestützte Entscheidungen zur Verbesserung Ihrer Sichtbarkeit in Suchmaschinen zu treffen.
|
||||
|
||||
Mit der Ahrefs-Integration in Sim können Sie:
|
||||
|
||||
- **Domain Rating & Autorität analysieren**: Überprüfen Sie sofort die Domain Rating (DR) und den Ahrefs Rank jeder Website, um deren Autorität einzuschätzen.
|
||||
- **Backlinks abrufen**: Rufen Sie eine Liste von Backlinks ab, die auf eine Website oder eine bestimmte URL verweisen, mit Details wie Ankertext, DR der verweisenden Seite und mehr.
|
||||
- **Backlink-Statistiken erhalten**: Greifen Sie auf Metriken zu Backlink-Typen (dofollow, nofollow, Text, Bild, Weiterleitung usw.) für eine Domain oder URL zu.
|
||||
- **Organische Keywords erkunden** *(geplant)*: Sehen Sie, für welche Keywords eine Domain rankt und welche Positionen sie in den Google-Suchergebnissen einnimmt.
|
||||
- **Top-Seiten entdecken** *(geplant)*: Identifizieren Sie die leistungsstärksten Seiten nach organischem Traffic und Links.
|
||||
|
||||
Diese Tools ermöglichen es Ihren Agenten, SEO-Recherchen zu automatisieren, Wettbewerber zu überwachen und Berichte zu erstellen – alles als Teil Ihrer Workflow-Automatisierungen. Um die Ahrefs-Integration zu nutzen, benötigen Sie ein Ahrefs Enterprise-Abonnement mit API-Zugang.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanleitung
|
||||
|
||||
Integrieren Sie Ahrefs SEO-Tools in Ihren Workflow. Analysieren Sie Domain-Ratings, Backlinks, organische Keywords, Top-Seiten und mehr. Erfordert einen Ahrefs Enterprise-Plan mit API-Zugang.
|
||||
|
||||
## Tools
|
||||
|
||||
### `ahrefs_domain_rating`
|
||||
|
||||
Erhalten Sie die Domain Rating (DR) und den Ahrefs Rank für eine Zieldomain. Die Domain Rating zeigt die Stärke einer Website
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Ja | Die zu analysierende Zieldomäne (z.B. example.com) |
|
||||
| `date` | string | Nein | Datum für historische Daten im Format YYYY-MM-DD (standardmäßig heute) |
|
||||
| `apiKey` | string | Ja | Ahrefs API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `domainRating` | number | Domain Rating Score (0-100) |
|
||||
| `ahrefsRank` | number | Ahrefs Rank - globales Ranking basierend auf der Stärke des Backlink-Profils |
|
||||
|
||||
### `ahrefs_backlinks`
|
||||
|
||||
Erhalte eine Liste von Backlinks, die auf eine Zieldomäne oder URL verweisen. Liefert Details zu jedem Backlink, einschließlich Quell-URL, Ankertext und Domain Rating.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Ja | Die zu analysierende Zieldomäne oder URL |
|
||||
| `mode` | string | Nein | Analysemodus: domain (gesamte Domäne), prefix (URL-Präfix), subdomains (alle Subdomänen einschließen), exact (exakte URL-Übereinstimmung) |
|
||||
| `date` | string | Nein | Datum für historische Daten im Format YYYY-MM-DD (standardmäßig heute) |
|
||||
| `limit` | number | Nein | Maximale Anzahl der zurückzugebenden Ergebnisse (Standard: 100) |
|
||||
| `offset` | number | Nein | Anzahl der zu überspringenden Ergebnisse für Paginierung |
|
||||
| `apiKey` | string | Ja | Ahrefs API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `backlinks` | array | Liste der Backlinks, die auf das Ziel verweisen |
|
||||
|
||||
### `ahrefs_backlinks_stats`
|
||||
|
||||
Ruft Backlink-Statistiken für eine Zieldomäne oder URL ab. Gibt Gesamtwerte für verschiedene Backlink-Typen zurück, einschließlich Dofollow-, Nofollow-, Text-, Bild- und Weiterleitungslinks.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Ja | Die zu analysierende Zieldomäne oder URL |
|
||||
| `mode` | string | Nein | Analysemodus: domain \(gesamte Domäne\), prefix \(URL-Präfix\), subdomains \(alle Subdomänen einschließen\), exact \(exakte URL-Übereinstimmung\) |
|
||||
| `date` | string | Nein | Datum für historische Daten im Format JJJJ-MM-TT \(standardmäßig heute\) |
|
||||
| `apiKey` | string | Ja | Ahrefs API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `stats` | object | Zusammenfassung der Backlink-Statistiken |
|
||||
|
||||
### `ahrefs_referring_domains`
|
||||
|
||||
Ruft eine Liste von Domänen ab, die auf eine Zieldomäne oder URL verlinken. Gibt eindeutige verweisende Domänen mit ihrem Domain-Rating, Backlink-Anzahl und Entdeckungsdaten zurück.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Ja | Die zu analysierende Zieldomäne oder URL |
|
||||
| `mode` | string | Nein | Analysemodus: domain \(gesamte Domäne\), prefix \(URL-Präfix\), subdomains \(alle Subdomänen einschließen\), exact \(exakte URL-Übereinstimmung\) |
|
||||
| `date` | string | Nein | Datum für historische Daten im Format JJJJ-MM-TT \(standardmäßig heute\) |
|
||||
| `limit` | number | Nein | Maximale Anzahl der zurückzugebenden Ergebnisse \(Standard: 100\) |
|
||||
| `offset` | number | Nein | Anzahl der zu überspringenden Ergebnisse für die Paginierung |
|
||||
| `apiKey` | string | Ja | Ahrefs API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `referringDomains` | array | Liste der Domains, die auf das Ziel verlinken |
|
||||
|
||||
### `ahrefs_organic_keywords`
|
||||
|
||||
Erhalte organische Keywords, für die eine Zieldomain oder URL in den Google-Suchergebnissen rankt. Liefert Keyword-Details einschließlich Suchvolumen, Ranking-Position und geschätztem Traffic.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Ja | Die zu analysierende Zieldomain oder URL |
|
||||
| `country` | string | Nein | Ländercode für Suchergebnisse \(z.B. us, gb, de\). Standard: us |
|
||||
| `mode` | string | Nein | Analysemodus: domain \(gesamte Domain\), prefix \(URL-Präfix\), subdomains \(alle Subdomains einschließen\), exact \(exakte URL-Übereinstimmung\) |
|
||||
| `date` | string | Nein | Datum für historische Daten im Format JJJJ-MM-TT \(standardmäßig heute\) |
|
||||
| `limit` | number | Nein | Maximale Anzahl der zurückzugebenden Ergebnisse \(Standard: 100\) |
|
||||
| `offset` | number | Nein | Anzahl der zu überspringenden Ergebnisse für Paginierung |
|
||||
| `apiKey` | string | Ja | Ahrefs API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `keywords` | array | Liste der organischen Keywords, für die das Ziel rankt |
|
||||
|
||||
### `ahrefs_top_pages`
|
||||
|
||||
Erhalte die Top-Seiten einer Zieldomain, sortiert nach organischem Traffic. Liefert Seiten-URLs mit ihrem Traffic, Keyword-Anzahl und geschätztem Traffic-Wert.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Ja | Die zu analysierende Zieldomäne |
|
||||
| `country` | string | Nein | Ländercode für Verkehrsdaten \(z.B. us, gb, de\). Standard: us |
|
||||
| `mode` | string | Nein | Analysemodus: domain \(gesamte Domain\), prefix \(URL-Präfix\), subdomains \(alle Subdomains einschließen\) |
|
||||
| `date` | string | Nein | Datum für historische Daten im Format JJJJ-MM-TT \(standardmäßig heute\) |
|
||||
| `limit` | number | Nein | Maximale Anzahl der zurückzugebenden Ergebnisse \(Standard: 100\) |
|
||||
| `offset` | number | Nein | Anzahl der zu überspringenden Ergebnisse für Paginierung |
|
||||
| `apiKey` | string | Ja | Ahrefs API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pages` | array | Liste der Top-Seiten nach organischem Traffic |
|
||||
|
||||
### `ahrefs_keyword_overview`
|
||||
|
||||
Erhalten Sie detaillierte Metriken für ein Keyword, einschließlich Suchvolumen, Keyword-Schwierigkeit, CPC, Klicks und Traffic-Potenzial.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyword` | string | Ja | Das zu analysierende Keyword |
|
||||
| `country` | string | Nein | Ländercode für Keyword-Daten \(z.B. us, gb, de\). Standard: us |
|
||||
| `apiKey` | string | Ja | Ahrefs API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `overview` | object | Keyword-Metriken Übersicht |
|
||||
|
||||
### `ahrefs_broken_backlinks`
|
||||
|
||||
Erhalte eine Liste defekter Backlinks, die auf eine Zieldomäne oder URL verweisen. Nützlich zur Identifizierung von Möglichkeiten zur Link-Wiederherstellung.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Ja | Die zu analysierende Zieldomäne oder URL |
|
||||
| `mode` | string | Nein | Analysemodus: domain \(gesamte Domäne\), prefix \(URL-Präfix\), subdomains \(alle Subdomänen einschließen\), exact \(exakte URL-Übereinstimmung\) |
|
||||
| `date` | string | Nein | Datum für historische Daten im Format JJJJ-MM-TT \(standardmäßig heute\) |
|
||||
| `limit` | number | Nein | Maximale Anzahl der zurückzugebenden Ergebnisse \(Standard: 100\) |
|
||||
| `offset` | number | Nein | Anzahl der zu überspringenden Ergebnisse für Paginierung |
|
||||
| `apiKey` | string | Ja | Ahrefs API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `brokenBacklinks` | array | Liste defekter Backlinks |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `ahrefs`
|
||||
89
apps/docs/content/docs/de/tools/apify.mdx
Normal file
89
apps/docs/content/docs/de/tools/apify.mdx
Normal file
@@ -0,0 +1,89 @@
|
||||
---
|
||||
title: Apify
|
||||
description: Führe Apify-Akteure aus und rufe Ergebnisse ab
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="apify"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Apify](https://apify.com/) ist eine leistungsstarke Plattform zum Erstellen, Bereitstellen und Ausführen von Web-Automatisierung und Web-Scraping-Akteuren im großen Maßstab. Apify ermöglicht es dir, nützliche Daten von jeder Website zu extrahieren, Arbeitsabläufe zu automatisieren und deine Datenpipelines nahtlos zu verbinden.
|
||||
|
||||
Mit Apify kannst du:
|
||||
|
||||
- **Vorgefertigte oder benutzerdefinierte Akteure ausführen**: Integriere öffentliche Akteure oder entwickle deine eigenen, um eine breite Palette von Webdatenextraktions- und Browser-Aufgaben zu automatisieren.
|
||||
- **Datensätze abrufen**: Greife auf strukturierte Datensätze zu, die von Akteuren in Echtzeit gesammelt wurden, und verwalte sie.
|
||||
- **Web-Automatisierung skalieren**: Nutze Cloud-Infrastruktur, um Aufgaben zuverlässig, asynchron oder synchron mit robuster Fehlerbehandlung auszuführen.
|
||||
|
||||
In Sim ermöglicht die Apify-Integration deinen Agenten, grundlegende Apify-Operationen programmatisch durchzuführen:
|
||||
|
||||
- **Akteur ausführen (Synchron)**: Verwende `apify_run_actor_sync`, um einen Apify-Akteur zu starten und auf dessen Abschluss zu warten, wobei die Ergebnisse sofort nach Beendigung des Laufs abgerufen werden.
|
||||
- **Akteur ausführen (Asynchron)**: Verwende `apify_run_actor_async`, um einen Akteur im Hintergrund zu starten und regelmäßig nach Ergebnissen zu fragen, was für längere oder komplexe Aufgaben geeignet ist.
|
||||
|
||||
Diese Operationen statten deine Agenten aus, um Datenerfassungs- oder Browser-Automatisierungsaufgaben direkt in Workflows zu automatisieren, zu scrapen und zu orchestrieren – alles mit flexibler Konfiguration und Ergebnisverarbeitung, ohne dass manuelle Ausführungen oder externe Tools erforderlich sind. Integriere Apify als dynamische Automatisierungs- und Datenextraktions-Engine, die programmatisch die webbasierten Workflows deiner Agenten antreibt.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Gebrauchsanweisung
|
||||
|
||||
Integriere Apify in deinen Workflow. Führe jeden Apify-Akteur mit benutzerdefinierter Eingabe aus und rufe Ergebnisse ab. Unterstützt sowohl synchrone als auch asynchrone Ausführung mit automatischem Datensatz-Abruf.
|
||||
|
||||
## Tools
|
||||
|
||||
### `apify_run_actor_sync`
|
||||
|
||||
Führe einen APIFY-Aktor synchron aus und erhalte Ergebnisse (maximal 5 Minuten)
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | APIFY API-Token von console.apify.com/account#/integrations |
|
||||
| `actorId` | string | Ja | Aktor-ID oder Benutzername/Aktor-Name \(z.B. "janedoe/my-actor" oder Aktor-ID\) |
|
||||
| `input` | string | Nein | Aktor-Eingabe als JSON-String. Siehe Aktor-Dokumentation für erforderliche Felder. |
|
||||
| `timeout` | number | Nein | Timeout in Sekunden \(Standard: Aktor-Standard\) |
|
||||
| `build` | string | Nein | Aktor-Build zum Ausführen \(z.B. "latest", "beta" oder Build-Tag/Nummer\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die Aktor-Ausführung erfolgreich war |
|
||||
| `runId` | string | APIFY-Ausführungs-ID |
|
||||
| `status` | string | Ausführungsstatus \(SUCCEEDED, FAILED, usw.\) |
|
||||
| `datasetId` | string | Dataset-ID mit Ergebnissen |
|
||||
| `items` | array | Dataset-Elemente \(falls abgeschlossen\) |
|
||||
|
||||
### `apify_run_actor_async`
|
||||
|
||||
Führe einen APIFY-Aktor asynchron mit Polling für lang laufende Aufgaben aus
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | APIFY API-Token von console.apify.com/account#/integrations |
|
||||
| `actorId` | string | Ja | Aktor-ID oder Benutzername/Aktor-Name \(z.B. "janedoe/my-actor" oder Aktor-ID\) |
|
||||
| `input` | string | Nein | Aktor-Eingabe als JSON-String |
|
||||
| `waitForFinish` | number | Nein | Anfängliche Wartezeit in Sekunden \(0-60\) bevor Polling beginnt |
|
||||
| `itemLimit` | number | Nein | Maximale Anzahl an Dataset-Elementen zum Abrufen \(1-250000, Standard 100\) |
|
||||
| `timeout` | number | Nein | Timeout in Sekunden \(Standard: Aktor-Standard\) |
|
||||
| `build` | string | Nein | Aktor-Build zum Ausführen \(z.B. "latest", "beta" oder Build-Tag/Nummer\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob der Actor-Lauf erfolgreich war |
|
||||
| `runId` | string | APIFY-Lauf-ID |
|
||||
| `status` | string | Laufstatus \(SUCCEEDED, FAILED, usw.\) |
|
||||
| `datasetId` | string | Dataset-ID mit Ergebnissen |
|
||||
| `items` | array | Dataset-Elemente \(falls abgeschlossen\) |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `apify`
|
||||
302
apps/docs/content/docs/de/tools/datadog.mdx
Normal file
302
apps/docs/content/docs/de/tools/datadog.mdx
Normal file
@@ -0,0 +1,302 @@
|
||||
---
|
||||
title: Datadog
|
||||
description: Überwachen Sie Infrastruktur, Anwendungen und Logs mit Datadog
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="datadog"
|
||||
color="#632CA6"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Datadog](https://datadoghq.com/) ist eine umfassende Überwachungs- und Analyseplattform für Infrastruktur, Anwendungen, Logs und mehr. Sie ermöglicht Organisationen Echtzeit-Einblicke in den Zustand und die Leistung von Systemen, erkennt Anomalien und automatisiert die Reaktion auf Vorfälle.
|
||||
|
||||
Mit Datadog können Sie:
|
||||
|
||||
- **Metriken überwachen**: Sammeln, visualisieren und analysieren Sie Metriken von Servern, Cloud-Diensten und benutzerdefinierten Anwendungen.
|
||||
- **Zeitreihendaten abfragen**: Führen Sie erweiterte Abfragen zu Leistungsmetriken für Trendanalysen und Berichte durch.
|
||||
- **Monitore und Ereignisse verwalten**: Richten Sie Monitore ein, um Probleme zu erkennen, Warnungen auszulösen und Ereignisse für die Beobachtbarkeit zu erstellen.
|
||||
- **Ausfallzeiten verwalten**: Planen und programmieren Sie geplante Ausfallzeiten, um Warnungen während der Wartung zu unterdrücken.
|
||||
- **Logs und Traces analysieren** *(mit zusätzlicher Einrichtung in Datadog)*: Zentralisieren und untersuchen Sie Logs oder verteilte Traces für eine tiefere Fehlerbehebung.
|
||||
|
||||
Die Datadog-Integration von Sim ermöglicht es Ihren Agenten, diese Vorgänge zu automatisieren und programmatisch mit Ihrem Datadog-Konto zu interagieren. Verwenden Sie sie, um benutzerdefinierte Metriken zu übermitteln, Zeitreihendaten abzufragen, Monitore zu verwalten, Ereignisse zu erstellen und Ihre Überwachungsabläufe direkt innerhalb von Sim-Automatisierungen zu optimieren.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Gebrauchsanweisung
|
||||
|
||||
Integrieren Sie Datadog-Überwachung in Workflows. Übermitteln Sie Metriken, verwalten Sie Monitore, fragen Sie Logs ab, erstellen Sie Ereignisse, handhaben Sie Ausfallzeiten und mehr.
|
||||
|
||||
## Tools
|
||||
|
||||
### `datadog_submit_metrics`
|
||||
|
||||
Übermitteln Sie benutzerdefinierte Metriken an Datadog. Verwenden Sie diese zur Verfolgung der Anwendungsleistung, Geschäftsmetriken oder benutzerdefinierten Überwachungsdaten.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `series` | string | Ja | JSON-Array von Metrikserien zur Übermittlung. Jede Serie sollte den Metriknamen, Typ \(gauge/rate/count\), Punkte \(Zeitstempel/Wert-Paare\) und optionale Tags enthalten. |
|
||||
| `apiKey` | string | Ja | Datadog API-Schlüssel |
|
||||
| `site` | string | Nein | Datadog-Site/Region \(Standard: datadoghq.com\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die Metriken erfolgreich übermittelt wurden |
|
||||
| `errors` | array | Alle Fehler, die während der Übermittlung aufgetreten sind |
|
||||
|
||||
### `datadog_query_timeseries`
|
||||
|
||||
Abfrage von Metrik-Zeitreihendaten aus Datadog. Verwenden Sie dies zur Analyse von Trends, zur Erstellung von Berichten oder zum Abrufen von Metrikwerten.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Ja | Datadog-Metrikabfrage (z.B. "avg:system.cpu.user\{*\}") |
|
||||
| `from` | number | Ja | Startzeit als Unix-Zeitstempel in Sekunden |
|
||||
| `to` | number | Ja | Endzeit als Unix-Zeitstempel in Sekunden |
|
||||
| `apiKey` | string | Ja | Datadog API-Schlüssel |
|
||||
| `applicationKey` | string | Ja | Datadog Anwendungsschlüssel |
|
||||
| `site` | string | Nein | Datadog-Site/Region (Standard: datadoghq.com) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | array | Array von Zeitreihendaten mit Metrikname, Tags und Datenpunkten |
|
||||
| `status` | string | Abfragestatus |
|
||||
|
||||
### `datadog_create_event`
|
||||
|
||||
Veröffentlichen Sie ein Ereignis im Datadog-Ereignisstrom. Verwenden Sie dies für Deployment-Benachrichtigungen, Warnungen oder andere wichtige Vorkommnisse.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `title` | string | Ja | Ereignistitel |
|
||||
| `text` | string | Ja | Ereignistext/Beschreibung. Unterstützt Markdown. |
|
||||
| `alertType` | string | Nein | Warnungstyp: error, warning, info, success, user_update, recommendation oder snapshot |
|
||||
| `priority` | string | Nein | Ereignispriorität: normal oder low |
|
||||
| `host` | string | Nein | Hostname, der mit diesem Ereignis verknüpft werden soll |
|
||||
| `tags` | string | Nein | Kommagetrennte Liste von Tags (z.B. "env:production,service:api") |
|
||||
| `aggregationKey` | string | Nein | Schlüssel zum Zusammenfassen von Ereignissen |
|
||||
| `sourceTypeName` | string | Nein | Quelltypname für das Ereignis |
|
||||
| `dateHappened` | number | Nein | Unix-Zeitstempel, wann das Ereignis aufgetreten ist (standardmäßig jetzt) |
|
||||
| `apiKey` | string | Ja | Datadog API-Schlüssel |
|
||||
| `site` | string | Nein | Datadog-Site/Region (Standard: datadoghq.com) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | Die Details des erstellten Events |
|
||||
|
||||
### `datadog_create_monitor`
|
||||
|
||||
Erstellen Sie einen neuen Monitor/Alert in Datadog. Monitore können Metriken, Service-Checks, Events und mehr überwachen.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `name` | string | Ja | Name des Monitors |
|
||||
| `type` | string | Ja | Monitor-Typ: metric alert, service check, event alert, process alert, log alert, query alert, composite, synthetics alert, slo alert |
|
||||
| `query` | string | Ja | Monitor-Abfrage (z.B. `avg(last_5m):avg:system.cpu.idle{*} < 20`) |
|
||||
| `message` | string | Nein | Nachricht, die bei Benachrichtigungen enthalten sein soll. Kann @-Erwähnungen und Markdown enthalten. |
|
||||
| `tags` | string | Nein | Kommagetrennte Liste von Tags |
|
||||
| `priority` | number | Nein | Monitor-Priorität (1-5, wobei 1 die höchste ist) |
|
||||
| `options` | string | Nein | JSON-String mit Monitor-Optionen (Schwellenwerte, notify_no_data, renotify_interval, usw.) |
|
||||
| `apiKey` | string | Ja | Datadog API-Schlüssel |
|
||||
| `applicationKey` | string | Ja | Datadog Anwendungsschlüssel |
|
||||
| `site` | string | Nein | Datadog Site/Region (Standard: datadoghq.com) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `monitor` | object | Die Details des erstellten Monitors |
|
||||
|
||||
### `datadog_get_monitor`
|
||||
|
||||
Rufen Sie Details eines bestimmten Monitors anhand seiner ID ab.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `monitorId` | string | Ja | Die ID des abzurufenden Monitors |
|
||||
| `groupStates` | string | Nein | Kommagetrennte Gruppenzustände, die einbezogen werden sollen: alert, warn, no data, ok |
|
||||
| `withDowntimes` | boolean | Nein | Downtime-Daten mit dem Monitor einbeziehen |
|
||||
| `apiKey` | string | Ja | Datadog API-Schlüssel |
|
||||
| `applicationKey` | string | Ja | Datadog Anwendungsschlüssel |
|
||||
| `site` | string | Nein | Datadog Site/Region (Standard: datadoghq.com) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `monitor` | object | Die Monitor-Details |
|
||||
|
||||
### `datadog_list_monitors`
|
||||
|
||||
Listet alle Monitore in Datadog auf, mit optionaler Filterung nach Namen, Tags oder Status.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupStates` | string | Nein | Kommagetrennte Gruppenstatus zur Filterung: alert, warn, no data, ok |
|
||||
| `name` | string | Nein | Filtert Monitore nach Namen \(teilweise Übereinstimmung\) |
|
||||
| `tags` | string | Nein | Kommagetrennte Liste von Tags zur Filterung |
|
||||
| `monitorTags` | string | Nein | Kommagetrennte Liste von Monitor-Tags zur Filterung |
|
||||
| `withDowntimes` | boolean | Nein | Downtime-Daten mit Monitoren einbeziehen |
|
||||
| `page` | number | Nein | Seitennummer für Paginierung \(0-indiziert\) |
|
||||
| `pageSize` | number | Nein | Anzahl der Monitore pro Seite \(max. 1000\) |
|
||||
| `apiKey` | string | Ja | Datadog API-Schlüssel |
|
||||
| `applicationKey` | string | Ja | Datadog Anwendungsschlüssel |
|
||||
| `site` | string | Nein | Datadog Site/Region \(Standard: datadoghq.com\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `monitors` | array | Liste der Monitore |
|
||||
|
||||
### `datadog_mute_monitor`
|
||||
|
||||
Stummschalten eines Monitors, um Benachrichtigungen vorübergehend zu unterdrücken.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `monitorId` | string | Ja | Die ID des stummzuschaltenden Monitors |
|
||||
| `scope` | string | Nein | Bereich zum Stummschalten \(z.B. "host:myhost"\). Wenn nicht angegeben, werden alle Bereiche stummgeschaltet. |
|
||||
| `end` | number | Nein | Unix-Zeitstempel, wann die Stummschaltung enden soll. Wenn nicht angegeben, wird auf unbestimmte Zeit stummgeschaltet. |
|
||||
| `apiKey` | string | Ja | Datadog API-Schlüssel |
|
||||
| `applicationKey` | string | Ja | Datadog Anwendungsschlüssel |
|
||||
| `site` | string | Nein | Datadog Site/Region \(Standard: datadoghq.com\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Gibt an, ob der Monitor erfolgreich stummgeschaltet wurde |
|
||||
|
||||
### `datadog_query_logs`
|
||||
|
||||
Suchen und abrufen von Logs aus Datadog. Verwenden Sie dies zur Fehlerbehebung, Analyse oder Überwachung.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Ja | Log-Suchabfrage (z.B. "service:web-app status:error") |
|
||||
| `from` | string | Ja | Startzeit im ISO-8601-Format oder relativ (z.B. "now-1h") |
|
||||
| `to` | string | Ja | Endzeit im ISO-8601-Format oder relativ (z.B. "now") |
|
||||
| `limit` | number | Nein | Maximale Anzahl der zurückzugebenden Logs (Standard: 50, max: 1000) |
|
||||
| `sort` | string | Nein | Sortierreihenfolge: timestamp (älteste zuerst) oder -timestamp (neueste zuerst) |
|
||||
| `indexes` | string | Nein | Kommagetrennte Liste der zu durchsuchenden Log-Indizes |
|
||||
| `apiKey` | string | Ja | Datadog API-Schlüssel |
|
||||
| `applicationKey` | string | Ja | Datadog Anwendungsschlüssel |
|
||||
| `site` | string | Nein | Datadog Site/Region (Standard: datadoghq.com) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `logs` | array | Liste der Log-Einträge |
|
||||
|
||||
### `datadog_send_logs`
|
||||
|
||||
Senden von Log-Einträgen an Datadog für zentralisiertes Logging und Analyse.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `logs` | string | Ja | JSON-Array von Log-Einträgen. Jeder Eintrag sollte message und optional ddsource, ddtags, hostname, service enthalten. |
|
||||
| `apiKey` | string | Ja | Datadog API-Schlüssel |
|
||||
| `site` | string | Nein | Datadog Site/Region (Standard: datadoghq.com) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die Logs erfolgreich gesendet wurden |
|
||||
|
||||
### `datadog_create_downtime`
|
||||
|
||||
Planen Sie eine Ausfallzeit, um Monitor-Benachrichtigungen während Wartungsfenstern zu unterdrücken.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `scope` | string | Yes | Bereich, auf den die Ausfallzeit angewendet werden soll (z.B. "host:myhost", "env:production" oder "*" für alle) |
|
||||
| `message` | string | No | Nachricht, die während der Ausfallzeit angezeigt werden soll |
|
||||
| `start` | number | No | Unix-Zeitstempel für den Beginn der Ausfallzeit (standardmäßig jetzt) |
|
||||
| `end` | number | No | Unix-Zeitstempel für das Ende der Ausfallzeit |
|
||||
| `timezone` | string | No | Zeitzone für die Ausfallzeit (z.B. "America/New_York") |
|
||||
| `monitorId` | string | No | Spezifische Monitor-ID, die stummgeschaltet werden soll |
|
||||
| `monitorTags` | string | No | Kommagetrennte Monitor-Tags zur Übereinstimmung (z.B. "team:backend,priority:high") |
|
||||
| `muteFirstRecoveryNotification` | boolean | No | Die erste Wiederherstellungsbenachrichtigung stummschalten |
|
||||
| `apiKey` | string | Yes | Datadog API-Schlüssel |
|
||||
| `applicationKey` | string | Yes | Datadog Anwendungsschlüssel |
|
||||
| `site` | string | No | Datadog Site/Region (Standard: datadoghq.com) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `downtime` | object | Die Details der erstellten Ausfallzeit |
|
||||
|
||||
### `datadog_list_downtimes`
|
||||
|
||||
Listet alle geplanten Ausfallzeiten in Datadog auf.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `currentOnly` | boolean | No | Nur aktuell aktive Ausfallzeiten zurückgeben |
|
||||
| `monitorId` | string | No | Nach Monitor-ID filtern |
|
||||
| `apiKey` | string | Yes | Datadog API-Schlüssel |
|
||||
| `applicationKey` | string | Yes | Datadog Anwendungsschlüssel |
|
||||
| `site` | string | No | Datadog Site/Region (Standard: datadoghq.com) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `downtimes` | array | Liste der Ausfallzeiten |
|
||||
|
||||
### `datadog_cancel_downtime`
|
||||
|
||||
Eine geplante Ausfallzeit abbrechen.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `downtimeId` | string | Ja | Die ID der abzubrechenden Ausfallzeit |
|
||||
| `apiKey` | string | Ja | Datadog API-Schlüssel |
|
||||
| `applicationKey` | string | Ja | Datadog Anwendungsschlüssel |
|
||||
| `site` | string | Nein | Datadog Site/Region \(Standard: datadoghq.com\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die Ausfallzeit erfolgreich abgebrochen wurde |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `datadog`
|
||||
219
apps/docs/content/docs/de/tools/dropbox.mdx
Normal file
219
apps/docs/content/docs/de/tools/dropbox.mdx
Normal file
@@ -0,0 +1,219 @@
|
||||
---
|
||||
title: Dropbox
|
||||
description: Dateien in Dropbox hochladen, herunterladen, teilen und verwalten
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="dropbox"
|
||||
color="#0061FF"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Dropbox](https://dropbox.com/) ist eine beliebte Cloud-Speicher- und Kollaborationsplattform, die es Einzelpersonen und Teams ermöglicht, Dateien sicher zu speichern, darauf zuzugreifen und sie von überall aus zu teilen. Dropbox ist für einfache Dateiverwaltung, Synchronisierung und leistungsstarke Zusammenarbeit konzipiert, egal ob Sie allein oder in einer Gruppe arbeiten.
|
||||
|
||||
Mit Dropbox in Sim können Sie:
|
||||
|
||||
- **Dateien hoch- und herunterladen**: Laden Sie jede Datei nahtlos in Ihre Dropbox hoch oder rufen Sie Inhalte bei Bedarf ab
|
||||
- **Ordnerinhalte auflisten**: Durchsuchen Sie die Dateien und Ordner in jedem Dropbox-Verzeichnis
|
||||
- **Neue Ordner erstellen**: Organisieren Sie Ihre Dateien, indem Sie programmgesteuert neue Ordner in Ihrer Dropbox erstellen
|
||||
- **Dateien und Ordner suchen**: Finden Sie Dokumente, Bilder oder andere Elemente nach Namen oder Inhalt
|
||||
- **Geteilte Links generieren**: Erstellen Sie schnell teilbare öffentliche oder private Links für Dateien und Ordner
|
||||
- **Dateien verwalten**: Verschieben, löschen oder benennen Sie Dateien und Ordner im Rahmen automatisierter Workflows um
|
||||
|
||||
Diese Funktionen ermöglichen es Ihren Sim-Agenten, Dropbox-Operationen direkt in Ihren Workflows zu automatisieren – vom Sichern wichtiger Dateien bis hin zur Verteilung von Inhalten und der Pflege organisierter Ordner. Verwenden Sie Dropbox sowohl als Quelle als auch als Ziel für Dateien und ermöglichen Sie so eine nahtlose Cloud-Speicherverwaltung als Teil Ihrer Geschäftsprozesse.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanweisungen
|
||||
|
||||
Integrieren Sie Dropbox in Ihren Workflow für Dateiverwaltung, Freigabe und Zusammenarbeit. Laden Sie Dateien hoch, laden Sie Inhalte herunter, erstellen Sie Ordner, verwalten Sie freigegebene Links und mehr.
|
||||
|
||||
## Tools
|
||||
|
||||
### `dropbox_upload`
|
||||
|
||||
Eine Datei zu Dropbox hochladen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Ja | Der Pfad in Dropbox, wo die Datei gespeichert werden soll \(z.B. /ordner/dokument.pdf\) |
|
||||
| `fileContent` | string | Ja | Der base64-kodierte Inhalt der hochzuladenden Datei |
|
||||
| `fileName` | string | Nein | Optionaler Dateiname \(wird verwendet, wenn der Pfad ein Ordner ist\) |
|
||||
| `mode` | string | Nein | Schreibmodus: add \(Standard\) oder overwrite |
|
||||
| `autorename` | boolean | Nein | Wenn true, wird die Datei umbenannt, falls ein Konflikt besteht |
|
||||
| `mute` | boolean | Nein | Wenn true, wird der Benutzer nicht über diesen Upload benachrichtigt |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | object | Die Metadaten der hochgeladenen Datei |
|
||||
|
||||
### `dropbox_download`
|
||||
|
||||
Eine Datei von Dropbox herunterladen und einen temporären Link erhalten
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Ja | Der Pfad der herunterzuladenden Datei (z.B. /ordner/dokument.pdf) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | object | Die Metadaten der Datei |
|
||||
|
||||
### `dropbox_list_folder`
|
||||
|
||||
Den Inhalt eines Ordners in Dropbox auflisten
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Ja | Der Pfad des aufzulistenden Ordners (verwende "" für das Stammverzeichnis) |
|
||||
| `recursive` | boolean | Nein | Wenn true, Inhalte rekursiv auflisten |
|
||||
| `includeDeleted` | boolean | Nein | Wenn true, gelöschte Dateien/Ordner einbeziehen |
|
||||
| `includeMediaInfo` | boolean | Nein | Wenn true, Medieninfos für Fotos/Videos einbeziehen |
|
||||
| `limit` | number | Nein | Maximale Anzahl der zurückzugebenden Ergebnisse (Standard: 500) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `entries` | array | Liste der Dateien und Ordner im Verzeichnis |
|
||||
|
||||
### `dropbox_create_folder`
|
||||
|
||||
Einen neuen Ordner in Dropbox erstellen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Ja | Der Pfad, an dem der Ordner erstellt werden soll (z.B. /neuer-ordner) |
|
||||
| `autorename` | boolean | Nein | Wenn true, den Ordner umbenennen, falls ein Konflikt besteht |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `folder` | object | Die Metadaten des erstellten Ordners |
|
||||
|
||||
### `dropbox_delete`
|
||||
|
||||
Eine Datei oder einen Ordner in Dropbox löschen (wird in den Papierkorb verschoben)
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Ja | Der Pfad der zu löschenden Datei oder des zu löschenden Ordners |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadaten des gelöschten Elements |
|
||||
|
||||
### `dropbox_copy`
|
||||
|
||||
Eine Datei oder einen Ordner in Dropbox kopieren
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `fromPath` | string | Ja | Der Quellpfad der zu kopierenden Datei oder des zu kopierenden Ordners |
|
||||
| `toPath` | string | Ja | Der Zielpfad für die kopierte Datei oder den kopierten Ordner |
|
||||
| `autorename` | boolean | Nein | Wenn true, wird die Datei umbenannt, falls am Zielort ein Konflikt besteht |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadaten des kopierten Elements |
|
||||
|
||||
### `dropbox_move`
|
||||
|
||||
Eine Datei oder einen Ordner in Dropbox verschieben oder umbenennen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `fromPath` | string | Ja | Der Quellpfad der zu verschiebenden Datei oder des zu verschiebenden Ordners |
|
||||
| `toPath` | string | Ja | Der Zielpfad für die verschobene Datei oder den verschobenen Ordner |
|
||||
| `autorename` | boolean | Nein | Wenn true, wird die Datei umbenannt, falls am Zielort ein Konflikt besteht |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadaten des verschobenen Elements |
|
||||
|
||||
### `dropbox_get_metadata`
|
||||
|
||||
Metadaten für eine Datei oder einen Ordner in Dropbox abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Ja | Der Pfad der Datei oder des Ordners, für die/den Metadaten abgerufen werden sollen |
|
||||
| `includeMediaInfo` | boolean | Nein | Wenn true, werden Medieninformationen für Fotos/Videos einbezogen |
|
||||
| `includeDeleted` | boolean | Nein | Wenn true, werden gelöschte Dateien in den Ergebnissen einbezogen |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadaten für die Datei oder den Ordner |
|
||||
|
||||
### `dropbox_create_shared_link`
|
||||
|
||||
Einen teilbaren Link für eine Datei oder einen Ordner in Dropbox erstellen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Ja | Der Pfad der Datei oder des Ordners, der geteilt werden soll |
|
||||
| `requestedVisibility` | string | Nein | Sichtbarkeit: public, team_only oder password |
|
||||
| `linkPassword` | string | Nein | Passwort für den geteilten Link \(nur wenn die Sichtbarkeit password ist\) |
|
||||
| `expires` | string | Nein | Ablaufdatum im ISO 8601-Format \(z.B. 2025-12-31T23:59:59Z\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `sharedLink` | object | Der erstellte geteilte Link |
|
||||
|
||||
### `dropbox_search`
|
||||
|
||||
Suche nach Dateien und Ordnern in Dropbox
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Ja | Die Suchanfrage |
|
||||
| `path` | string | Nein | Suche auf einen bestimmten Ordnerpfad beschränken |
|
||||
| `fileExtensions` | string | Nein | Kommagetrennte Liste von Dateierweiterungen zur Filterung \(z.B. pdf,xlsx\) |
|
||||
| `maxResults` | number | Nein | Maximale Anzahl der zurückzugebenden Ergebnisse \(Standard: 100\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `matches` | array | Suchergebnisse |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `dropbox`
|
||||
188
apps/docs/content/docs/de/tools/dynamodb.mdx
Normal file
188
apps/docs/content/docs/de/tools/dynamodb.mdx
Normal file
@@ -0,0 +1,188 @@
|
||||
---
|
||||
title: Amazon DynamoDB
|
||||
description: Verbindung zu Amazon DynamoDB
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="dynamodb"
|
||||
color="linear-gradient(45deg, #2E27AD 0%, #527FFF 100%)"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Amazon DynamoDB](https://aws.amazon.com/dynamodb/) ist ein vollständig verwalteter NoSQL-Datenbankdienst von AWS, der schnelle und vorhersehbare Leistung mit nahtloser Skalierbarkeit bietet. Mit DynamoDB können Sie beliebige Datenmengen speichern und abrufen und jede Art von Anforderungsverkehr bedienen, ohne dass Sie Hardware oder Infrastruktur verwalten müssen.
|
||||
|
||||
Mit DynamoDB können Sie:
|
||||
|
||||
- **Elemente abrufen**: Elemente in Ihren Tabellen mithilfe von Primärschlüsseln nachschlagen
|
||||
- **Elemente einfügen**: Elemente in Ihren Tabellen hinzufügen oder ersetzen
|
||||
- **Elemente abfragen**: Mehrere Elemente mithilfe von Abfragen über Indizes abrufen
|
||||
- **Tabellen scannen**: Alle oder einen Teil der Daten in einer Tabelle lesen
|
||||
- **Elemente aktualisieren**: Bestimmte Attribute vorhandener Elemente ändern
|
||||
- **Elemente löschen**: Datensätze aus Ihren Tabellen entfernen
|
||||
|
||||
In Sim ermöglicht die DynamoDB-Integration Ihren Agenten den sicheren Zugriff auf DynamoDB-Tabellen und deren Manipulation mithilfe von AWS-Anmeldeinformationen. Zu den unterstützten Operationen gehören:
|
||||
|
||||
- **Get**: Ein Element anhand seines Schlüssels abrufen
|
||||
- **Put**: Elemente einfügen oder überschreiben
|
||||
- **Query**: Abfragen mit Schlüsselbedingungen und Filtern ausführen
|
||||
- **Scan**: Mehrere Elemente durch Scannen der Tabelle oder des Index lesen
|
||||
- **Update**: Bestimmte Attribute eines oder mehrerer Elemente ändern
|
||||
- **Delete**: Ein Element aus einer Tabelle entfernen
|
||||
|
||||
Diese Integration ermöglicht es Sim-Agenten, Datenverwaltungsaufgaben innerhalb Ihrer DynamoDB-Tabellen programmatisch zu automatisieren, sodass Sie Workflows erstellen können, die skalierbare NoSQL-Daten ohne manuellen Aufwand oder Serververwaltung verwalten, ändern und abrufen.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanweisungen
|
||||
|
||||
Integrieren Sie Amazon DynamoDB in Workflows. Unterstützt Get-, Put-, Query-, Scan-, Update- und Delete-Operationen auf DynamoDB-Tabellen.
|
||||
|
||||
## Tools
|
||||
|
||||
### `dynamodb_get`
|
||||
|
||||
Ein Element aus einer DynamoDB-Tabelle anhand des Primärschlüssels abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Ja | AWS-Region (z.B. us-east-1) |
|
||||
| `accessKeyId` | string | Ja | AWS-Zugriffsschlüssel-ID |
|
||||
| `secretAccessKey` | string | Ja | AWS-Geheimzugriffsschlüssel |
|
||||
| `tableName` | string | Ja | DynamoDB-Tabellenname |
|
||||
| `key` | object | Ja | Primärschlüssel des abzurufenden Elements |
|
||||
| `consistentRead` | boolean | Nein | Stark konsistentes Lesen verwenden |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
| `item` | object | Abgerufenes Element |
|
||||
|
||||
### `dynamodb_put`
|
||||
|
||||
Ein Element in eine DynamoDB-Tabelle einfügen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Ja | AWS-Region (z.B. us-east-1) |
|
||||
| `accessKeyId` | string | Ja | AWS-Zugriffsschlüssel-ID |
|
||||
| `secretAccessKey` | string | Ja | AWS-Geheimzugriffsschlüssel |
|
||||
| `tableName` | string | Ja | DynamoDB-Tabellenname |
|
||||
| `item` | object | Ja | Element, das in die Tabelle eingefügt werden soll |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
| `item` | object | Erstelltes Element |
|
||||
|
||||
### `dynamodb_query`
|
||||
|
||||
Abfrage von Elementen aus einer DynamoDB-Tabelle mit Schlüsselbedingungen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Ja | AWS-Region (z.B. us-east-1) |
|
||||
| `accessKeyId` | string | Ja | AWS-Zugriffsschlüssel-ID |
|
||||
| `secretAccessKey` | string | Ja | AWS-Geheimzugriffsschlüssel |
|
||||
| `tableName` | string | Ja | DynamoDB-Tabellenname |
|
||||
| `keyConditionExpression` | string | Ja | Schlüsselbedingungsausdruck (z.B. "pk = :pk") |
|
||||
| `filterExpression` | string | Nein | Filterausdruck für Ergebnisse |
|
||||
| `expressionAttributeNames` | object | Nein | Attributnamenzuordnungen für reservierte Wörter |
|
||||
| `expressionAttributeValues` | object | Nein | Ausdrucksattributwerte |
|
||||
| `indexName` | string | Nein | Name des sekundären Index für die Abfrage |
|
||||
| `limit` | number | Nein | Maximale Anzahl der zurückzugebenden Elemente |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
| `items` | array | Array der zurückgegebenen Elemente |
|
||||
| `count` | number | Anzahl der zurückgegebenen Elemente |
|
||||
|
||||
### `dynamodb_scan`
|
||||
|
||||
Alle Elemente in einer DynamoDB-Tabelle scannen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Ja | AWS-Region (z.B. us-east-1) |
|
||||
| `accessKeyId` | string | Ja | AWS-Zugriffsschlüssel-ID |
|
||||
| `secretAccessKey` | string | Ja | AWS-Geheimzugriffsschlüssel |
|
||||
| `tableName` | string | Ja | DynamoDB-Tabellenname |
|
||||
| `filterExpression` | string | Nein | Filterausdruck für Ergebnisse |
|
||||
| `projectionExpression` | string | Nein | Abzurufende Attribute |
|
||||
| `expressionAttributeNames` | object | Nein | Attributnamenzuordnungen für reservierte Wörter |
|
||||
| `expressionAttributeValues` | object | Nein | Ausdrucksattributwerte |
|
||||
| `limit` | number | Nein | Maximale Anzahl der zurückzugebenden Elemente |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
| `items` | array | Array der zurückgegebenen Elemente |
|
||||
| `count` | number | Anzahl der zurückgegebenen Elemente |
|
||||
|
||||
### `dynamodb_update`
|
||||
|
||||
Ein Element in einer DynamoDB-Tabelle aktualisieren
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Ja | AWS-Region (z.B. us-east-1) |
|
||||
| `accessKeyId` | string | Ja | AWS-Zugriffsschlüssel-ID |
|
||||
| `secretAccessKey` | string | Ja | AWS-Geheimzugriffsschlüssel |
|
||||
| `tableName` | string | Ja | Name der DynamoDB-Tabelle |
|
||||
| `key` | object | Ja | Primärschlüssel des zu aktualisierenden Elements |
|
||||
| `updateExpression` | string | Ja | Aktualisierungsausdruck (z.B. "SET #name = :name") |
|
||||
| `expressionAttributeNames` | object | Nein | Attributnamenzuordnungen für reservierte Wörter |
|
||||
| `expressionAttributeValues` | object | Nein | Ausdrucksattributwerte |
|
||||
| `conditionExpression` | string | Nein | Bedingung, die erfüllt sein muss, damit die Aktualisierung erfolgreich ist |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
| `item` | object | Aktualisiertes Element |
|
||||
|
||||
### `dynamodb_delete`
|
||||
|
||||
Ein Element aus einer DynamoDB-Tabelle löschen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Ja | AWS-Region (z.B. us-east-1) |
|
||||
| `accessKeyId` | string | Ja | AWS-Zugriffsschlüssel-ID |
|
||||
| `secretAccessKey` | string | Ja | AWS-Geheimzugriffsschlüssel |
|
||||
| `tableName` | string | Ja | Name der DynamoDB-Tabelle |
|
||||
| `key` | object | Ja | Primärschlüssel des zu löschenden Elements |
|
||||
| `conditionExpression` | string | Nein | Bedingung, die erfüllt sein muss, damit das Löschen erfolgreich ist |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `dynamodb`
|
||||
365
apps/docs/content/docs/de/tools/elasticsearch.mdx
Normal file
365
apps/docs/content/docs/de/tools/elasticsearch.mdx
Normal file
@@ -0,0 +1,365 @@
|
||||
---
|
||||
title: Elasticsearch
|
||||
description: Suchen, indexieren und verwalten Sie Daten in Elasticsearch
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="elasticsearch"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Elasticsearch](https://www.elastic.co/elasticsearch/) ist eine leistungsstarke verteilte Such- und Analysemaschine, die es Ihnen ermöglicht, große Datenmengen in Echtzeit zu indexieren, zu durchsuchen und zu analysieren. Sie wird häufig für Suchfunktionen, Log- und Ereignisdatenanalysen, Beobachtbarkeit und mehr eingesetzt.
|
||||
|
||||
Mit Elasticsearch in Sim erhalten Sie programmatischen Zugriff auf die Kernfunktionen von Elasticsearch, darunter:
|
||||
|
||||
- **Dokumente durchsuchen**: Führen Sie erweiterte Suchen in strukturiertem oder unstrukturiertem Text mit Query DSL durch, mit Unterstützung für Sortierung, Paginierung und Feldauswahl.
|
||||
- **Dokumente indexieren**: Fügen Sie neue Dokumente hinzu oder aktualisieren Sie bestehende in jedem Elasticsearch-Index für sofortigen Abruf und Analyse.
|
||||
- **Dokumente abrufen, aktualisieren oder löschen**: Rufen Sie bestimmte Dokumente nach ID ab, ändern oder entfernen Sie sie.
|
||||
- **Massenoperationen**: Führen Sie mehrere Indexierungs- oder Aktualisierungsaktionen in einer einzigen Anfrage für Datenverarbeitung mit hohem Durchsatz aus.
|
||||
- **Indizes verwalten**: Erstellen, löschen oder rufen Sie Details zu Indizes als Teil Ihrer Workflow-Automatisierung ab.
|
||||
- **Cluster-Überwachung**: Überprüfen Sie den Zustand und die Statistiken Ihrer Elasticsearch-Bereitstellung.
|
||||
|
||||
Sims Elasticsearch-Tools funktionieren sowohl mit selbst gehosteten als auch mit Elastic Cloud-Umgebungen. Integrieren Sie Elasticsearch in Ihre Agent-Workflows, um die Datenaufnahme zu automatisieren, große Datensätze zu durchsuchen, Berichte zu erstellen oder benutzerdefinierte, suchgestützte Anwendungen zu erstellen – alles ohne manuelle Eingriffe.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanweisungen
|
||||
|
||||
Integrieren Sie Elasticsearch in Workflows für leistungsstarke Suche, Indexierung und Datenverwaltung. Unterstützt CRUD-Operationen für Dokumente, erweiterte Suchabfragen, Massenoperationen, Indexverwaltung und Cluster-Überwachung. Funktioniert sowohl mit selbst gehosteten als auch mit Elastic Cloud-Bereitstellungen.
|
||||
|
||||
## Tools
|
||||
|
||||
### `elasticsearch_search`
|
||||
|
||||
Durchsuche Dokumente in Elasticsearch mit Query DSL. Gibt übereinstimmende Dokumente mit Scores und Metadaten zurück.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Ja | Bereitstellungstyp: self_hosted oder cloud |
|
||||
| `host` | string | Nein | Elasticsearch-Host-URL (für self-hosted) |
|
||||
| `cloudId` | string | Nein | Elastic Cloud ID (für Cloud-Bereitstellungen) |
|
||||
| `authMethod` | string | Ja | Authentifizierungsmethode: api_key oder basic_auth |
|
||||
| `apiKey` | string | Nein | Elasticsearch API-Schlüssel |
|
||||
| `username` | string | Nein | Benutzername für Basic Auth |
|
||||
| `password` | string | Nein | Passwort für Basic Auth |
|
||||
| `index` | string | Ja | Indexname für die Suche |
|
||||
| `query` | string | Nein | Query DSL als JSON-String |
|
||||
| `from` | number | Nein | Startoffset für Paginierung (Standard: 0) |
|
||||
| `size` | number | Nein | Anzahl der zurückzugebenden Ergebnisse (Standard: 10) |
|
||||
| `sort` | string | Nein | Sortierungsspezifikation als JSON-String |
|
||||
| `sourceIncludes` | string | Nein | Kommagetrennte Liste von Feldern, die in _source eingeschlossen werden sollen |
|
||||
| `sourceExcludes` | string | Nein | Kommagetrennte Liste von Feldern, die aus _source ausgeschlossen werden sollen |
|
||||
| `trackTotalHits` | boolean | Nein | Genaue Gesamttrefferanzahl verfolgen (Standard: true) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `took` | number | Zeit in Millisekunden, die die Suche gedauert hat |
|
||||
| `timed_out` | boolean | Ob die Suche ein Timeout hatte |
|
||||
| `hits` | object | Suchergebnisse mit Gesamtanzahl und übereinstimmenden Dokumenten |
|
||||
| `aggregations` | json | Aggregationsergebnisse, falls vorhanden |
|
||||
|
||||
### `elasticsearch_index_document`
|
||||
|
||||
Dokument in Elasticsearch indexieren (erstellen oder aktualisieren).
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Ja | Bereitstellungstyp: self_hosted oder cloud |
|
||||
| `host` | string | Nein | Elasticsearch-Host-URL \(für self-hosted\) |
|
||||
| `cloudId` | string | Nein | Elastic Cloud ID \(für Cloud-Bereitstellungen\) |
|
||||
| `authMethod` | string | Ja | Authentifizierungsmethode: api_key oder basic_auth |
|
||||
| `apiKey` | string | Nein | Elasticsearch API-Schlüssel |
|
||||
| `username` | string | Nein | Benutzername für Basic-Auth |
|
||||
| `password` | string | Nein | Passwort für Basic-Auth |
|
||||
| `index` | string | Ja | Zielindexname |
|
||||
| `documentId` | string | Nein | Dokument-ID \(wird automatisch generiert, wenn nicht angegeben\) |
|
||||
| `document` | string | Ja | Dokumentinhalt als JSON-String |
|
||||
| `refresh` | string | Nein | Aktualisierungsrichtlinie: true, false oder wait_for |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `_index` | string | Index, in dem das Dokument gespeichert wurde |
|
||||
| `_id` | string | Dokument-ID |
|
||||
| `_version` | number | Dokumentversion |
|
||||
| `result` | string | Operationsergebnis \(erstellt oder aktualisiert\) |
|
||||
|
||||
### `elasticsearch_get_document`
|
||||
|
||||
Dokument anhand der ID aus Elasticsearch abrufen.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Ja | Bereitstellungstyp: self_hosted oder cloud |
|
||||
| `host` | string | Nein | Elasticsearch-Host-URL \(für self-hosted\) |
|
||||
| `cloudId` | string | Nein | Elastic Cloud ID \(für Cloud-Bereitstellungen\) |
|
||||
| `authMethod` | string | Ja | Authentifizierungsmethode: api_key oder basic_auth |
|
||||
| `apiKey` | string | Nein | Elasticsearch API-Schlüssel |
|
||||
| `username` | string | Nein | Benutzername für Basic-Auth |
|
||||
| `password` | string | Nein | Passwort für Basic-Auth |
|
||||
| `index` | string | Ja | Indexname |
|
||||
| `documentId` | string | Ja | Abzurufende Dokument-ID |
|
||||
| `sourceIncludes` | string | Nein | Kommagetrennte Liste der einzuschließenden Felder |
|
||||
| `sourceExcludes` | string | Nein | Kommagetrennte Liste der auszuschließenden Felder |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `_index` | string | Indexname |
|
||||
| `_id` | string | Dokument-ID |
|
||||
| `_version` | number | Dokumentversion |
|
||||
| `found` | boolean | Ob das Dokument gefunden wurde |
|
||||
| `_source` | json | Dokumentinhalt |
|
||||
|
||||
### `elasticsearch_update_document`
|
||||
|
||||
Teilweise Aktualisierung eines Dokuments in Elasticsearch mittels Doc-Merge.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Ja | Bereitstellungstyp: self_hosted oder cloud |
|
||||
| `host` | string | Nein | Elasticsearch-Host-URL (für self-hosted) |
|
||||
| `cloudId` | string | Nein | Elastic Cloud ID (für Cloud-Bereitstellungen) |
|
||||
| `authMethod` | string | Ja | Authentifizierungsmethode: api_key oder basic_auth |
|
||||
| `apiKey` | string | Nein | Elasticsearch API-Schlüssel |
|
||||
| `username` | string | Nein | Benutzername für Basic Auth |
|
||||
| `password` | string | Nein | Passwort für Basic Auth |
|
||||
| `index` | string | Ja | Indexname |
|
||||
| `documentId` | string | Ja | Zu aktualisierende Dokument-ID |
|
||||
| `document` | string | Ja | Teilweise Dokument zum Zusammenführen als JSON-String |
|
||||
| `retryOnConflict` | number | Nein | Anzahl der Wiederholungen bei Versionskonflikten |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `_index` | string | Indexname |
|
||||
| `_id` | string | Dokument-ID |
|
||||
| `_version` | number | Neue Dokumentversion |
|
||||
| `result` | string | Operationsergebnis (updated oder noop) |
|
||||
|
||||
### `elasticsearch_delete_document`
|
||||
|
||||
Löschen eines Dokuments aus Elasticsearch anhand der ID.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Ja | Bereitstellungstyp: self_hosted oder cloud |
|
||||
| `host` | string | Nein | Elasticsearch-Host-URL \(für self-hosted\) |
|
||||
| `cloudId` | string | Nein | Elastic Cloud ID \(für Cloud-Bereitstellungen\) |
|
||||
| `authMethod` | string | Ja | Authentifizierungsmethode: api_key oder basic_auth |
|
||||
| `apiKey` | string | Nein | Elasticsearch API-Schlüssel |
|
||||
| `username` | string | Nein | Benutzername für Basic-Auth |
|
||||
| `password` | string | Nein | Passwort für Basic-Auth |
|
||||
| `index` | string | Ja | Index-Name |
|
||||
| `documentId` | string | Ja | Dokument-ID zum Löschen |
|
||||
| `refresh` | string | Nein | Aktualisierungsrichtlinie: true, false oder wait_for |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `_index` | string | Index-Name |
|
||||
| `_id` | string | Dokument-ID |
|
||||
| `_version` | number | Dokumentversion |
|
||||
| `result` | string | Operationsergebnis \(deleted oder not_found\) |
|
||||
|
||||
### `elasticsearch_bulk`
|
||||
|
||||
Führen Sie mehrere Index-, Erstellungs-, Lösch- oder Aktualisierungsoperationen in einer einzigen Anfrage für hohe Leistung durch.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Ja | Bereitstellungstyp: self_hosted oder cloud |
|
||||
| `host` | string | Nein | Elasticsearch-Host-URL \(für self-hosted\) |
|
||||
| `cloudId` | string | Nein | Elastic Cloud ID \(für Cloud-Bereitstellungen\) |
|
||||
| `authMethod` | string | Ja | Authentifizierungsmethode: api_key oder basic_auth |
|
||||
| `apiKey` | string | Nein | Elasticsearch API-Schlüssel |
|
||||
| `username` | string | Nein | Benutzername für Basic-Auth |
|
||||
| `password` | string | Nein | Passwort für Basic-Auth |
|
||||
| `index` | string | Nein | Standardindex für Operationen, die keinen angeben |
|
||||
| `operations` | string | Ja | Massenoperationen als NDJSON-String \(zeilenweise abgegrenztes JSON\) |
|
||||
| `refresh` | string | Nein | Aktualisierungsrichtlinie: true, false oder wait_for |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `took` | number | Zeit in Millisekunden, die der Massenvorgang gedauert hat |
|
||||
| `errors` | boolean | Ob ein Vorgang einen Fehler hatte |
|
||||
| `items` | array | Ergebnisse für jeden Vorgang |
|
||||
|
||||
### `elasticsearch_count`
|
||||
|
||||
Zählt Dokumente, die einer Abfrage in Elasticsearch entsprechen.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Ja | Bereitstellungstyp: self_hosted oder cloud |
|
||||
| `host` | string | Nein | Elasticsearch-Host-URL \(für self-hosted\) |
|
||||
| `cloudId` | string | Nein | Elastic Cloud ID \(für Cloud-Bereitstellungen\) |
|
||||
| `authMethod` | string | Ja | Authentifizierungsmethode: api_key oder basic_auth |
|
||||
| `apiKey` | string | Nein | Elasticsearch API-Schlüssel |
|
||||
| `username` | string | Nein | Benutzername für Basic-Auth |
|
||||
| `password` | string | Nein | Passwort für Basic-Auth |
|
||||
| `index` | string | Ja | Indexname, in dem Dokumente gezählt werden sollen |
|
||||
| `query` | string | Nein | Optionale Abfrage zum Filtern von Dokumenten \(JSON-String\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `count` | number | Anzahl der Dokumente, die der Abfrage entsprechen |
|
||||
| `_shards` | object | Shard-Statistiken |
|
||||
|
||||
### `elasticsearch_create_index`
|
||||
|
||||
Erstellt einen neuen Index mit optionalen Einstellungen und Mappings.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Ja | Bereitstellungstyp: self_hosted oder cloud |
|
||||
| `host` | string | Nein | Elasticsearch-Host-URL \(für self-hosted\) |
|
||||
| `cloudId` | string | Nein | Elastic Cloud ID \(für Cloud-Bereitstellungen\) |
|
||||
| `authMethod` | string | Ja | Authentifizierungsmethode: api_key oder basic_auth |
|
||||
| `apiKey` | string | Nein | Elasticsearch API-Schlüssel |
|
||||
| `username` | string | Nein | Benutzername für Basic-Auth |
|
||||
| `password` | string | Nein | Passwort für Basic-Auth |
|
||||
| `index` | string | Ja | Zu erstellender Indexname |
|
||||
| `settings` | string | Nein | Indexeinstellungen als JSON-String |
|
||||
| `mappings` | string | Nein | Index-Mappings als JSON-String |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `acknowledged` | boolean | Ob die Anfrage bestätigt wurde |
|
||||
| `shards_acknowledged` | boolean | Ob die Shards bestätigt wurden |
|
||||
| `index` | string | Name des erstellten Index |
|
||||
|
||||
### `elasticsearch_delete_index`
|
||||
|
||||
Löscht einen Index und alle seine Dokumente. Dieser Vorgang ist nicht rückgängig zu machen.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Ja | Bereitstellungstyp: self_hosted oder cloud |
|
||||
| `host` | string | Nein | Elasticsearch-Host-URL \(für self-hosted\) |
|
||||
| `cloudId` | string | Nein | Elastic Cloud ID \(für Cloud-Bereitstellungen\) |
|
||||
| `authMethod` | string | Ja | Authentifizierungsmethode: api_key oder basic_auth |
|
||||
| `apiKey` | string | Nein | Elasticsearch API-Schlüssel |
|
||||
| `username` | string | Nein | Benutzername für Basic-Auth |
|
||||
| `password` | string | Nein | Passwort für Basic-Auth |
|
||||
| `index` | string | Ja | Name des zu löschenden Index |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `acknowledged` | boolean | Ob die Löschung bestätigt wurde |
|
||||
|
||||
### `elasticsearch_get_index`
|
||||
|
||||
Ruft Indexinformationen ab, einschließlich Einstellungen, Mappings und Aliase.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Ja | Bereitstellungstyp: self_hosted oder cloud |
|
||||
| `host` | string | Nein | Elasticsearch-Host-URL \(für self-hosted\) |
|
||||
| `cloudId` | string | Nein | Elastic Cloud ID \(für Cloud-Bereitstellungen\) |
|
||||
| `authMethod` | string | Ja | Authentifizierungsmethode: api_key oder basic_auth |
|
||||
| `apiKey` | string | Nein | Elasticsearch API-Schlüssel |
|
||||
| `username` | string | Nein | Benutzername für Basic-Auth |
|
||||
| `password` | string | Nein | Passwort für Basic-Auth |
|
||||
| `index` | string | Ja | Name des Index, für den Informationen abgerufen werden sollen |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `index` | json | Indexinformationen einschließlich Aliase, Mappings und Einstellungen |
|
||||
|
||||
### `elasticsearch_cluster_health`
|
||||
|
||||
Ruft den Gesundheitsstatus des Elasticsearch-Clusters ab.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Ja | Bereitstellungstyp: self_hosted oder cloud |
|
||||
| `host` | string | Nein | Elasticsearch-Host-URL \(für self-hosted\) |
|
||||
| `cloudId` | string | Nein | Elastic Cloud ID \(für Cloud-Bereitstellungen\) |
|
||||
| `authMethod` | string | Ja | Authentifizierungsmethode: api_key oder basic_auth |
|
||||
| `apiKey` | string | Nein | Elasticsearch API-Schlüssel |
|
||||
| `username` | string | Nein | Benutzername für Basic-Auth |
|
||||
| `password` | string | Nein | Passwort für Basic-Auth |
|
||||
| `waitForStatus` | string | Nein | Warten bis der Cluster diesen Status erreicht: green, yellow oder red |
|
||||
| `timeout` | string | Nein | Timeout für den Wartevorgang \(z.B. 30s, 1m\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `cluster_name` | string | Name des Clusters |
|
||||
| `status` | string | Cluster-Gesundheitsstatus: green, yellow oder red |
|
||||
| `number_of_nodes` | number | Gesamtzahl der Knoten im Cluster |
|
||||
| `number_of_data_nodes` | number | Anzahl der Datenknoten |
|
||||
| `active_shards` | number | Anzahl der aktiven Shards |
|
||||
| `unassigned_shards` | number | Anzahl der nicht zugewiesenen Shards |
|
||||
|
||||
### `elasticsearch_cluster_stats`
|
||||
|
||||
Erhalte umfassende Statistiken über den Elasticsearch-Cluster.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Ja | Bereitstellungstyp: self_hosted oder cloud |
|
||||
| `host` | string | Nein | Elasticsearch-Host-URL \(für self-hosted\) |
|
||||
| `cloudId` | string | Nein | Elastic Cloud ID \(für Cloud-Bereitstellungen\) |
|
||||
| `authMethod` | string | Ja | Authentifizierungsmethode: api_key oder basic_auth |
|
||||
| `apiKey` | string | Nein | Elasticsearch API-Schlüssel |
|
||||
| `username` | string | Nein | Benutzername für Basic-Auth |
|
||||
| `password` | string | Nein | Passwort für Basic-Auth |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `cluster_name` | string | Name des Clusters |
|
||||
| `status` | string | Cluster-Gesundheitsstatus |
|
||||
| `nodes` | object | Knotenstatistiken einschließlich Anzahl und Versionen |
|
||||
| `indices` | object | Indexstatistiken einschließlich Dokumentanzahl und Speichergröße |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `elasticsearch`
|
||||
429
apps/docs/content/docs/de/tools/gitlab.mdx
Normal file
429
apps/docs/content/docs/de/tools/gitlab.mdx
Normal file
@@ -0,0 +1,429 @@
|
||||
---
|
||||
title: GitLab
|
||||
description: Interagiere mit GitLab-Projekten, Issues, Merge Requests und Pipelines
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="gitlab"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[GitLab](https://gitlab.com/) ist eine umfassende DevOps-Plattform, die Teams ermöglicht, ihren Software-Entwicklungszyklus zu verwalten, zusammenzuarbeiten und zu automatisieren. Mit GitLab kannst du mühelos Quellcodeverwaltung, CI/CD, Reviews und Zusammenarbeit in einer einzigen Anwendung handhaben.
|
||||
|
||||
Mit GitLab in Sim kannst du:
|
||||
|
||||
- **Projekte und Repositories verwalten**: Liste und rufe deine GitLab-Projekte ab, greife auf Details zu und organisiere deine Repositories
|
||||
- **Mit Issues arbeiten**: Issues auflisten, erstellen und kommentieren, um Arbeit zu verfolgen und effektiv zusammenzuarbeiten
|
||||
- **Merge Requests bearbeiten**: Überprüfe, erstelle und verwalte Merge Requests für Codeänderungen und Peer-Reviews
|
||||
- **CI/CD-Pipelines automatisieren**: Starte, überwache und interagiere mit GitLab-Pipelines als Teil deiner Automatisierungsabläufe
|
||||
- **Mit Kommentaren zusammenarbeiten**: Füge Kommentare zu Issues oder Merge Requests hinzu für eine effiziente Kommunikation innerhalb deines Teams
|
||||
|
||||
Mit Sims GitLab-Integration können deine Agenten programmatisch mit deinen GitLab-Projekten interagieren. Automatisiere Projektverwaltung, Issue-Tracking, Code-Reviews und Pipeline-Operationen nahtlos in deinen Workflows, optimiere deinen Software-Entwicklungsprozess und verbessere die Zusammenarbeit in deinem Team.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanleitung
|
||||
|
||||
Integriere GitLab in den Workflow. Kann Projekte, Issues, Merge Requests, Pipelines verwalten und Kommentare hinzufügen. Unterstützt alle grundlegenden GitLab DevOps-Operationen.
|
||||
|
||||
## Tools
|
||||
|
||||
### `gitlab_list_projects`
|
||||
|
||||
GitLab-Projekte auflisten, auf die der authentifizierte Benutzer Zugriff hat
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `owned` | boolean | Nein | Beschränkung auf Projekte, die dem aktuellen Benutzer gehören |
|
||||
| `membership` | boolean | Nein | Beschränkung auf Projekte, in denen der aktuelle Benutzer Mitglied ist |
|
||||
| `search` | string | Nein | Projekte nach Namen durchsuchen |
|
||||
| `visibility` | string | Nein | Nach Sichtbarkeit filtern \(public, internal, private\) |
|
||||
| `orderBy` | string | Nein | Nach Feld sortieren \(id, name, path, created_at, updated_at, last_activity_at\) |
|
||||
| `sort` | string | Nein | Sortierrichtung \(asc, desc\) |
|
||||
| `perPage` | number | Nein | Anzahl der Ergebnisse pro Seite \(Standard 20, max 100\) |
|
||||
| `page` | number | Nein | Seitennummer für Paginierung |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `projects` | array | Liste der GitLab-Projekte |
|
||||
| `total` | number | Gesamtanzahl der Projekte |
|
||||
|
||||
### `gitlab_get_project`
|
||||
|
||||
Details zu einem bestimmten GitLab-Projekt abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad \(z.B. "namespace/project"\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `project` | object | Die GitLab-Projektdetails |
|
||||
|
||||
### `gitlab_list_issues`
|
||||
|
||||
Issues in einem GitLab-Projekt auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `state` | string | Nein | Nach Status filtern \(opened, closed, all\) |
|
||||
| `labels` | string | Nein | Kommagetrennte Liste von Label-Namen |
|
||||
| `assigneeId` | number | Nein | Nach Bearbeiter-Benutzer-ID filtern |
|
||||
| `milestoneTitle` | string | Nein | Nach Meilenstein-Titel filtern |
|
||||
| `search` | string | Nein | Issues nach Titel und Beschreibung durchsuchen |
|
||||
| `orderBy` | string | Nein | Sortieren nach Feld \(created_at, updated_at\) |
|
||||
| `sort` | string | Nein | Sortierrichtung \(asc, desc\) |
|
||||
| `perPage` | number | Nein | Anzahl der Ergebnisse pro Seite \(Standard 20, max 100\) |
|
||||
| `page` | number | Nein | Seitennummer für Paginierung |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issues` | array | Liste der GitLab-Issues |
|
||||
| `total` | number | Gesamtanzahl der Issues |
|
||||
|
||||
### `gitlab_get_issue`
|
||||
|
||||
Details zu einem bestimmten GitLab-Issue abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `issueIid` | number | Ja | Issue-Nummer innerhalb des Projekts \(die # in der GitLab-UI angezeigt\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issue` | object | Die GitLab-Issue-Details |
|
||||
|
||||
### `gitlab_create_issue`
|
||||
|
||||
Ein neues Issue in einem GitLab-Projekt erstellen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `title` | string | Ja | Issue-Titel |
|
||||
| `description` | string | Nein | Issue-Beschreibung \(Markdown unterstützt\) |
|
||||
| `labels` | string | Nein | Kommagetrennte Liste von Label-Namen |
|
||||
| `assigneeIds` | array | Nein | Array von Benutzer-IDs für die Zuweisung |
|
||||
| `milestoneId` | number | Nein | Meilenstein-ID für die Zuweisung |
|
||||
| `dueDate` | string | Nein | Fälligkeitsdatum im Format JJJJ-MM-TT |
|
||||
| `confidential` | boolean | Nein | Ob das Issue vertraulich ist |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issue` | object | Das erstellte GitLab-Issue |
|
||||
|
||||
### `gitlab_update_issue`
|
||||
|
||||
Ein bestehendes Issue in einem GitLab-Projekt aktualisieren
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `issueIid` | number | Ja | Interne Issue-ID (IID) |
|
||||
| `title` | string | Nein | Neuer Issue-Titel |
|
||||
| `description` | string | Nein | Neue Issue-Beschreibung (Markdown unterstützt) |
|
||||
| `stateEvent` | string | Nein | Status-Event (close oder reopen) |
|
||||
| `labels` | string | Nein | Kommagetrennte Liste von Label-Namen |
|
||||
| `assigneeIds` | array | Nein | Array von Benutzer-IDs für die Zuweisung |
|
||||
| `milestoneId` | number | Nein | Meilenstein-ID für die Zuweisung |
|
||||
| `dueDate` | string | Nein | Fälligkeitsdatum im Format JJJJ-MM-TT |
|
||||
| `confidential` | boolean | Nein | Ob das Issue vertraulich ist |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issue` | object | Das aktualisierte GitLab-Issue |
|
||||
|
||||
### `gitlab_delete_issue`
|
||||
|
||||
Ein Issue aus einem GitLab-Projekt löschen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `issueIid` | number | Ja | Interne Issue-ID (IID) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob das Issue erfolgreich gelöscht wurde |
|
||||
|
||||
### `gitlab_create_issue_note`
|
||||
|
||||
Einen Kommentar zu einem GitLab-Issue hinzufügen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `issueIid` | number | Ja | Interne Issue-ID (IID) |
|
||||
| `body` | string | Ja | Kommentartext (Markdown unterstützt) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `note` | object | Der erstellte Kommentar |
|
||||
|
||||
### `gitlab_list_merge_requests`
|
||||
|
||||
Merge-Requests in einem GitLab-Projekt auflisten
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `state` | string | Nein | Nach Status filtern (opened, closed, merged, all) |
|
||||
| `labels` | string | Nein | Kommagetrennte Liste von Label-Namen |
|
||||
| `sourceBranch` | string | Nein | Nach Quell-Branch filtern |
|
||||
| `targetBranch` | string | Nein | Nach Ziel-Branch filtern |
|
||||
| `orderBy` | string | Nein | Sortieren nach Feld (created_at, updated_at) |
|
||||
| `sort` | string | Nein | Sortierrichtung (asc, desc) |
|
||||
| `perPage` | number | Nein | Anzahl der Ergebnisse pro Seite (Standard 20, max 100) |
|
||||
| `page` | number | Nein | Seitennummer für Paginierung |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequests` | array | Liste der GitLab Merge-Requests |
|
||||
| `total` | number | Gesamtanzahl der Merge-Requests |
|
||||
|
||||
### `gitlab_get_merge_request`
|
||||
|
||||
Details zu einem bestimmten GitLab Merge-Request abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `mergeRequestIid` | number | Ja | Interne ID des Merge-Requests \(IID\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequest` | object | Die Details des GitLab Merge-Requests |
|
||||
|
||||
### `gitlab_create_merge_request`
|
||||
|
||||
Einen neuen Merge-Request in einem GitLab-Projekt erstellen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `sourceBranch` | string | Ja | Name des Quellbranches |
|
||||
| `targetBranch` | string | Ja | Name des Zielbranches |
|
||||
| `title` | string | Ja | Titel des Merge-Requests |
|
||||
| `description` | string | Nein | Beschreibung des Merge-Requests \(Markdown unterstützt\) |
|
||||
| `labels` | string | Nein | Kommagetrennte Liste von Label-Namen |
|
||||
| `assigneeIds` | array | Nein | Array von Benutzer-IDs für die Zuweisung |
|
||||
| `milestoneId` | number | Nein | Meilenstein-ID für die Zuweisung |
|
||||
| `removeSourceBranch` | boolean | Nein | Quellbranch nach dem Merge löschen |
|
||||
| `squash` | boolean | Nein | Commits beim Merge zusammenfassen |
|
||||
| `draft` | boolean | Nein | Als Entwurf markieren \(in Bearbeitung\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequest` | object | Der erstellte GitLab Merge Request |
|
||||
|
||||
### `gitlab_update_merge_request`
|
||||
|
||||
Einen bestehenden Merge Request in einem GitLab-Projekt aktualisieren
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Projekt-ID oder URL-kodierter Pfad |
|
||||
| `mergeRequestIid` | number | Yes | Interne ID des Merge Requests \(IID\) |
|
||||
| `title` | string | No | Neuer Titel des Merge Requests |
|
||||
| `description` | string | No | Neue Beschreibung des Merge Requests |
|
||||
| `stateEvent` | string | No | Status-Event \(close oder reopen\) |
|
||||
| `labels` | string | No | Kommagetrennte Liste von Label-Namen |
|
||||
| `assigneeIds` | array | No | Array von Benutzer-IDs für die Zuweisung |
|
||||
| `milestoneId` | number | No | Meilenstein-ID für die Zuweisung |
|
||||
| `targetBranch` | string | No | Neuer Ziel-Branch |
|
||||
| `removeSourceBranch` | boolean | No | Quell-Branch nach dem Merge löschen |
|
||||
| `squash` | boolean | No | Commits beim Merge zusammenfassen |
|
||||
| `draft` | boolean | No | Als Entwurf markieren \(work in progress\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequest` | object | Der aktualisierte GitLab Merge Request |
|
||||
|
||||
### `gitlab_merge_merge_request`
|
||||
|
||||
Einen Merge Request in einem GitLab-Projekt zusammenführen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Projekt-ID oder URL-kodierter Pfad |
|
||||
| `mergeRequestIid` | number | Yes | Interne ID des Merge Requests \(IID\) |
|
||||
| `mergeCommitMessage` | string | No | Benutzerdefinierte Merge-Commit-Nachricht |
|
||||
| `squashCommitMessage` | string | No | Benutzerdefinierte Squash-Commit-Nachricht |
|
||||
| `squash` | boolean | No | Commits vor dem Merge zusammenfassen |
|
||||
| `shouldRemoveSourceBranch` | boolean | No | Quell-Branch nach dem Merge löschen |
|
||||
| `mergeWhenPipelineSucceeds` | boolean | No | Merge durchführen, wenn Pipeline erfolgreich ist |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequest` | object | Der zusammengeführte GitLab Merge Request |
|
||||
|
||||
### `gitlab_create_merge_request_note`
|
||||
|
||||
Einen Kommentar zu einem GitLab Merge Request hinzufügen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-kodierter Pfad |
|
||||
| `mergeRequestIid` | number | Ja | Interne ID des Merge Requests \(IID\) |
|
||||
| `body` | string | Ja | Kommentartext \(Markdown wird unterstützt\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `note` | object | Der erstellte Kommentar |
|
||||
|
||||
### `gitlab_list_pipelines`
|
||||
|
||||
Pipelines in einem GitLab-Projekt auflisten
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-kodierter Pfad |
|
||||
| `ref` | string | Nein | Nach Ref filtern \(Branch oder Tag\) |
|
||||
| `status` | string | Nein | Nach Status filtern \(created, waiting_for_resource, preparing, pending, running, success, failed, canceled, skipped, manual, scheduled\) |
|
||||
| `orderBy` | string | Nein | Sortieren nach Feld \(id, status, ref, updated_at, user_id\) |
|
||||
| `sort` | string | Nein | Sortierrichtung \(asc, desc\) |
|
||||
| `perPage` | number | Nein | Anzahl der Ergebnisse pro Seite \(Standard 20, max 100\) |
|
||||
| `page` | number | Nein | Seitennummer für Paginierung |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipelines` | array | Liste der GitLab-Pipelines |
|
||||
| `total` | number | Gesamtanzahl der Pipelines |
|
||||
|
||||
### `gitlab_get_pipeline`
|
||||
|
||||
Details zu einer bestimmten GitLab-Pipeline abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `pipelineId` | number | Ja | Pipeline-ID |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipeline` | object | Die GitLab-Pipeline-Details |
|
||||
|
||||
### `gitlab_create_pipeline`
|
||||
|
||||
Eine neue Pipeline in einem GitLab-Projekt auslösen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `ref` | string | Ja | Branch oder Tag, auf dem die Pipeline ausgeführt werden soll |
|
||||
| `variables` | array | Nein | Array von Variablen für die Pipeline \(jede mit key, value und optionalem variable_type\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipeline` | object | Die erstellte GitLab-Pipeline |
|
||||
|
||||
### `gitlab_retry_pipeline`
|
||||
|
||||
Eine fehlgeschlagene GitLab-Pipeline wiederholen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `pipelineId` | number | Ja | Pipeline-ID |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipeline` | object | Die wiederholte GitLab-Pipeline |
|
||||
|
||||
### `gitlab_cancel_pipeline`
|
||||
|
||||
Eine laufende GitLab-Pipeline abbrechen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Ja | Projekt-ID oder URL-codierter Pfad |
|
||||
| `pipelineId` | number | Ja | Pipeline-ID |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipeline` | object | Die abgebrochene GitLab-Pipeline |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `gitlab`
|
||||
494
apps/docs/content/docs/de/tools/grafana.mdx
Normal file
494
apps/docs/content/docs/de/tools/grafana.mdx
Normal file
@@ -0,0 +1,494 @@
|
||||
---
|
||||
title: Grafana
|
||||
description: Interagiere mit Grafana-Dashboards, Alarmen und Anmerkungen
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="grafana"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Grafana](https://grafana.com/) ist eine führende Open-Source-Plattform für Monitoring, Observability und Visualisierung. Sie ermöglicht Benutzern, Daten aus verschiedenen Quellen abzufragen, zu visualisieren, zu überwachen und zu analysieren, was sie zu einem wesentlichen Werkzeug für Infrastruktur- und Anwendungsmonitoring macht.
|
||||
|
||||
Mit Grafana kannst du:
|
||||
|
||||
- **Daten visualisieren**: Dashboards erstellen und anpassen, um Metriken, Logs und Traces in Echtzeit anzuzeigen
|
||||
- **Gesundheit und Status überwachen**: Den Zustand deiner Grafana-Instanz und verbundener Datenquellen überprüfen
|
||||
- **Alarme und Anmerkungen verwalten**: Alarmregeln einrichten, Benachrichtigungen verwalten und Dashboards mit wichtigen Ereignissen versehen
|
||||
- **Inhalte organisieren**: Dashboards und Datenquellen in Ordnern organisieren für besseres Zugriffsmanagement
|
||||
|
||||
In Sim ermöglicht die Grafana-Integration deinen Agenten, direkt über die API mit deiner Grafana-Instanz zu interagieren, was Aktionen wie folgende ermöglicht:
|
||||
|
||||
- Überprüfung des Gesundheitsstatus von Grafana-Server, Datenbank und Datenquellen
|
||||
- Abrufen, Auflisten und Verwalten von Dashboards, Alarmregeln, Anmerkungen, Datenquellen und Ordnern
|
||||
- Automatisierung der Überwachung deiner Infrastruktur durch Integration von Grafana-Daten und Alarmen in deine Workflow-Automatisierungen
|
||||
|
||||
Diese Fähigkeiten ermöglichen es Sim-Agenten, Systeme zu überwachen, proaktiv auf Alarme zu reagieren und die Zuverlässigkeit und Sichtbarkeit deiner Dienste zu gewährleisten – alles als Teil deiner automatisierten Workflows.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanleitung
|
||||
|
||||
Integriere Grafana in Workflows. Verwalte Dashboards, Alarme, Anmerkungen, Datenquellen, Ordner und überwache den Gesundheitsstatus.
|
||||
|
||||
## Tools
|
||||
|
||||
### `grafana_get_dashboard`
|
||||
|
||||
Ein Dashboard anhand seiner UID abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `dashboardUid` | string | Ja | Die UID des abzurufenden Dashboards |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `dashboard` | json | Das vollständige Dashboard-JSON-Objekt |
|
||||
| `meta` | json | Dashboard-Metadaten \(Version, Berechtigungen usw.\) |
|
||||
|
||||
### `grafana_list_dashboards`
|
||||
|
||||
Suchen und auflisten aller Dashboards
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `query` | string | Nein | Suchanfrage zum Filtern von Dashboards nach Titel |
|
||||
| `tag` | string | Nein | Nach Tag filtern \(kommagetrennt für mehrere Tags\) |
|
||||
| `folderIds` | string | Nein | Nach Ordner-IDs filtern \(kommagetrennt\) |
|
||||
| `starred` | boolean | Nein | Nur mit Stern markierte Dashboards zurückgeben |
|
||||
| `limit` | number | Nein | Maximale Anzahl der zurückzugebenden Dashboards |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `dashboards` | array | Liste der Dashboard-Suchergebnisse |
|
||||
|
||||
### `grafana_create_dashboard`
|
||||
|
||||
Ein neues Dashboard erstellen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `title` | string | Ja | Der Titel des neuen Dashboards |
|
||||
| `folderUid` | string | Nein | Die UID des Ordners, in dem das Dashboard erstellt werden soll |
|
||||
| `tags` | string | Nein | Kommagetrennte Liste von Tags |
|
||||
| `timezone` | string | Nein | Dashboard-Zeitzone \(z.B. browser, utc\) |
|
||||
| `refresh` | string | Nein | Auto-Aktualisierungsintervall \(z.B. 5s, 1m, 5m\) |
|
||||
| `panels` | string | Nein | JSON-Array von Panel-Konfigurationen |
|
||||
| `overwrite` | boolean | Nein | Vorhandenes Dashboard mit gleichem Titel überschreiben |
|
||||
| `message` | string | Nein | Commit-Nachricht für die Dashboard-Version |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | Die numerische ID des erstellten Dashboards |
|
||||
| `uid` | string | Die UID des erstellten Dashboards |
|
||||
| `url` | string | Der URL-Pfad zum Dashboard |
|
||||
| `status` | string | Status der Operation \(success\) |
|
||||
| `version` | number | Die Versionsnummer des Dashboards |
|
||||
| `slug` | string | URL-freundlicher Slug des Dashboards |
|
||||
|
||||
### `grafana_update_dashboard`
|
||||
|
||||
Aktualisiert ein bestehendes Dashboard. Ruft das aktuelle Dashboard ab und führt Ihre Änderungen zusammen.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `dashboardUid` | string | Ja | Die UID des zu aktualisierenden Dashboards |
|
||||
| `title` | string | Nein | Neuer Titel für das Dashboard |
|
||||
| `folderUid` | string | Nein | Neue Ordner-UID, um das Dashboard zu verschieben |
|
||||
| `tags` | string | Nein | Kommagetrennte Liste neuer Tags |
|
||||
| `timezone` | string | Nein | Dashboard-Zeitzone \(z.B. browser, utc\) |
|
||||
| `refresh` | string | Nein | Auto-Refresh-Intervall \(z.B. 5s, 1m, 5m\) |
|
||||
| `panels` | string | Nein | JSON-Array von Panel-Konfigurationen |
|
||||
| `overwrite` | boolean | Nein | Überschreiben auch bei Versionskonflikten |
|
||||
| `message` | string | Nein | Commit-Nachricht für diese Version |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | Die numerische ID des aktualisierten Dashboards |
|
||||
| `uid` | string | Die UID des aktualisierten Dashboards |
|
||||
| `url` | string | Der URL-Pfad zum Dashboard |
|
||||
| `status` | string | Status der Operation \(success\) |
|
||||
| `version` | number | Die neue Versionsnummer des Dashboards |
|
||||
| `slug` | string | URL-freundlicher Slug des Dashboards |
|
||||
|
||||
### `grafana_delete_dashboard`
|
||||
|
||||
Löschen eines Dashboards anhand seiner UID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `dashboardUid` | string | Ja | Die UID des zu löschenden Dashboards |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `title` | string | Der Titel des gelöschten Dashboards |
|
||||
| `message` | string | Bestätigungsnachricht |
|
||||
| `id` | number | Die ID des gelöschten Dashboards |
|
||||
|
||||
### `grafana_list_alert_rules`
|
||||
|
||||
Alle Alarmregeln in der Grafana-Instanz auflisten
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `rules` | array | Liste der Alarmregeln |
|
||||
|
||||
### `grafana_get_alert_rule`
|
||||
|
||||
Eine bestimmte Alarmregel anhand ihrer UID abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `alertRuleUid` | string | Ja | Die UID der abzurufenden Alarmregel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `uid` | string | Alarmregel-UID |
|
||||
| `title` | string | Alarmregel-Titel |
|
||||
| `condition` | string | Alarmbedingung |
|
||||
| `data` | json | Alarmregel-Abfragedaten |
|
||||
| `folderUID` | string | Übergeordnete Ordner-UID |
|
||||
| `ruleGroup` | string | Regelgruppenname |
|
||||
| `noDataState` | string | Status, wenn keine Daten zurückgegeben werden |
|
||||
| `execErrState` | string | Status bei Ausführungsfehler |
|
||||
| `annotations` | json | Alarmanmerkungen |
|
||||
| `labels` | json | Alarmlabels |
|
||||
|
||||
### `grafana_create_alert_rule`
|
||||
|
||||
Eine neue Alarmregel erstellen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `title` | string | Ja | Der Titel der Alarmregel |
|
||||
| `folderUid` | string | Ja | Die UID des Ordners, in dem der Alarm erstellt werden soll |
|
||||
| `ruleGroup` | string | Ja | Der Name der Regelgruppe |
|
||||
| `condition` | string | Ja | Die refId der Abfrage oder des Ausdrucks, der als Alarmbedingung verwendet werden soll |
|
||||
| `data` | string | Ja | JSON-Array von Abfrage-/Ausdrucksdatenobjekten |
|
||||
| `forDuration` | string | Nein | Wartezeit vor dem Auslösen \(z.B. 5m, 1h\) |
|
||||
| `noDataState` | string | Nein | Status, wenn keine Daten zurückgegeben werden \(NoData, Alerting, OK\) |
|
||||
| `execErrState` | string | Nein | Status bei Ausführungsfehler \(Alerting, OK\) |
|
||||
| `annotations` | string | Nein | JSON-Objekt von Anmerkungen |
|
||||
| `labels` | string | Nein | JSON-Objekt von Labels |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `uid` | string | Die UID der erstellten Alarmregel |
|
||||
| `title` | string | Titel der Alarmregel |
|
||||
| `folderUID` | string | UID des übergeordneten Ordners |
|
||||
| `ruleGroup` | string | Name der Regelgruppe |
|
||||
|
||||
### `grafana_update_alert_rule`
|
||||
|
||||
Aktualisiert eine bestehende Alarmregel. Ruft die aktuelle Regel ab und führt Ihre Änderungen zusammen.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service-Account-Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL (z.B. https://your-grafana.com) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `alertRuleUid` | string | Ja | Die UID der zu aktualisierenden Alarmregel |
|
||||
| `title` | string | Nein | Neuer Titel für die Alarmregel |
|
||||
| `folderUid` | string | Nein | Neue Ordner-UID, um den Alarm zu verschieben |
|
||||
| `ruleGroup` | string | Nein | Neuer Name der Regelgruppe |
|
||||
| `condition` | string | Nein | Neue Bedingung refId |
|
||||
| `data` | string | Nein | Neues JSON-Array von Abfrage-/Ausdrucksdatenobjekten |
|
||||
| `forDuration` | string | Nein | Wartezeit vor dem Auslösen (z.B. 5m, 1h) |
|
||||
| `noDataState` | string | Nein | Status, wenn keine Daten zurückgegeben werden (NoData, Alerting, OK) |
|
||||
| `execErrState` | string | Nein | Status bei Ausführungsfehler (Alerting, OK) |
|
||||
| `annotations` | string | Nein | JSON-Objekt von Anmerkungen |
|
||||
| `labels` | string | Nein | JSON-Objekt von Labels |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `uid` | string | Die UID der aktualisierten Alarmregel |
|
||||
| `title` | string | Titel der Alarmregel |
|
||||
| `folderUID` | string | UID des übergeordneten Ordners |
|
||||
| `ruleGroup` | string | Name der Regelgruppe |
|
||||
|
||||
### `grafana_delete_alert_rule`
|
||||
|
||||
Löschen einer Alarmregel anhand ihrer UID
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service-Account-Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `alertRuleUid` | string | Ja | Die UID der zu löschenden Alarmregel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Bestätigungsnachricht |
|
||||
|
||||
### `grafana_list_contact_points`
|
||||
|
||||
Alle Alarmbenachrichtigungs-Kontaktpunkte auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service-Account-Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contactPoints` | array | Liste der Kontaktpunkte |
|
||||
|
||||
### `grafana_create_annotation`
|
||||
|
||||
Eine Anmerkung auf einem Dashboard oder als globale Anmerkung erstellen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `text` | string | Ja | Der Textinhalt der Anmerkung |
|
||||
| `tags` | string | Nein | Kommagetrennte Liste von Tags |
|
||||
| `dashboardUid` | string | Nein | UID des Dashboards, zu dem die Anmerkung hinzugefügt werden soll \(optional für globale Anmerkungen\) |
|
||||
| `panelId` | number | Nein | ID des Panels, zu dem die Anmerkung hinzugefügt werden soll |
|
||||
| `time` | number | Nein | Startzeit in Epochenmillisekunden \(standardmäßig jetzt\) |
|
||||
| `timeEnd` | number | Nein | Endzeit in Epochenmillisekunden \(für Bereichsanmerkungen\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | Die ID der erstellten Anmerkung |
|
||||
| `message` | string | Bestätigungsnachricht |
|
||||
|
||||
### `grafana_list_annotations`
|
||||
|
||||
Anmerkungen nach Zeitraum, Dashboard oder Tags abfragen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `from` | number | Nein | Startzeit in Epochenmillisekunden |
|
||||
| `to` | number | Nein | Endzeit in Epochenmillisekunden |
|
||||
| `dashboardUid` | string | Nein | Nach Dashboard-UID filtern |
|
||||
| `panelId` | number | Nein | Nach Panel-ID filtern |
|
||||
| `tags` | string | Nein | Kommagetrennte Liste von Tags, nach denen gefiltert werden soll |
|
||||
| `type` | string | Nein | Nach Typ filtern \(alert oder annotation\) |
|
||||
| `limit` | number | Nein | Maximale Anzahl von zurückzugebenden Anmerkungen |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `annotations` | array | Liste der Anmerkungen |
|
||||
|
||||
### `grafana_update_annotation`
|
||||
|
||||
Eine vorhandene Anmerkung aktualisieren
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service-Account-Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `annotationId` | number | Ja | Die ID der zu aktualisierenden Anmerkung |
|
||||
| `text` | string | Ja | Neuer Textinhalt für die Anmerkung |
|
||||
| `tags` | string | Nein | Kommagetrennte Liste neuer Tags |
|
||||
| `time` | number | Nein | Neue Startzeit in Epochenmillisekunden |
|
||||
| `timeEnd` | number | Nein | Neue Endzeit in Epochenmillisekunden |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | Die ID der aktualisierten Anmerkung |
|
||||
| `message` | string | Bestätigungsnachricht |
|
||||
|
||||
### `grafana_delete_annotation`
|
||||
|
||||
Eine Anmerkung anhand ihrer ID löschen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service-Account-Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `annotationId` | number | Ja | Die ID der zu löschenden Anmerkung |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Bestätigungsnachricht |
|
||||
|
||||
### `grafana_list_data_sources`
|
||||
|
||||
Alle in Grafana konfigurierten Datenquellen auflisten
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `dataSources` | array | Liste der Datenquellen |
|
||||
|
||||
### `grafana_get_data_source`
|
||||
|
||||
Eine Datenquelle anhand ihrer ID oder UID abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Multi-Org-Grafana-Instanzen |
|
||||
| `dataSourceId` | string | Ja | Die ID oder UID der abzurufenden Datenquelle |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | Datenquellen-ID |
|
||||
| `uid` | string | Datenquellen-UID |
|
||||
| `name` | string | Name der Datenquelle |
|
||||
| `type` | string | Typ der Datenquelle |
|
||||
| `url` | string | Verbindungs-URL der Datenquelle |
|
||||
| `database` | string | Datenbankname \(falls zutreffend\) |
|
||||
| `isDefault` | boolean | Ob dies die Standard-Datenquelle ist |
|
||||
| `jsonData` | json | Zusätzliche Konfiguration der Datenquelle |
|
||||
|
||||
### `grafana_list_folders`
|
||||
|
||||
Alle Ordner in Grafana auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Grafana-Instanzen mit mehreren Organisationen |
|
||||
| `limit` | number | Nein | Maximale Anzahl der zurückzugebenden Ordner |
|
||||
| `page` | number | Nein | Seitennummer für Paginierung |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `folders` | array | Liste der Ordner |
|
||||
|
||||
### `grafana_create_folder`
|
||||
|
||||
Einen neuen Ordner in Grafana erstellen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Ja | Grafana-Instanz-URL \(z.B. https://your-grafana.com\) |
|
||||
| `organizationId` | string | Nein | Organisations-ID für Grafana-Instanzen mit mehreren Organisationen |
|
||||
| `title` | string | Ja | Der Titel des neuen Ordners |
|
||||
| `uid` | string | Nein | Optionale UID für den Ordner \(wird automatisch generiert, wenn nicht angegeben\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | Die numerische ID des erstellten Ordners |
|
||||
| `uid` | string | Die UID des erstellten Ordners |
|
||||
| `title` | string | Der Titel des erstellten Ordners |
|
||||
| `url` | string | Der URL-Pfad zum Ordner |
|
||||
|
||||
## Notizen
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `grafana`
|
||||
295
apps/docs/content/docs/de/tools/kalshi.mdx
Normal file
295
apps/docs/content/docs/de/tools/kalshi.mdx
Normal file
@@ -0,0 +1,295 @@
|
||||
---
|
||||
title: Kalshi
|
||||
description: Zugriff auf Prognosemarktdaten von Kalshi
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="kalshi"
|
||||
color="#09C285"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Kalshi](https://kalshi.com) ist eine bundesweit regulierte Börse, an der Nutzer direkt mit den Ergebnissen zukünftiger Ereignisse handeln können – Prognosemärkte. Kalshis robuste API und Sim-Integration ermöglichen es Agenten und Workflows, programmatisch auf alle Aspekte der Plattform zuzugreifen und unterstützen alles von Forschung und Analyse bis hin zu automatisiertem Handel und Überwachung.
|
||||
|
||||
Mit Kalshis Integration in Sim können Sie:
|
||||
|
||||
- **Markt- & Ereignisdaten:** Echtzeit- und historische Daten für Märkte und Ereignisse suchen, filtern und abrufen; detaillierte Informationen zum Marktstatus, Serien, Ereignisgruppierungen und mehr abrufen.
|
||||
- **Konto- & Guthaben-Management:** Zugriff auf Kontostände, verfügbare Mittel und Überwachung von Echtzeit-Positionen.
|
||||
- **Auftrags- & Handelsmanagement:** Neue Aufträge platzieren, bestehende stornieren, offene Aufträge einsehen, ein Live-Orderbuch abrufen und auf vollständige Handelshistorien zugreifen.
|
||||
- **Ausführungsanalyse:** Abruf von aktuellen Trades, historischen Ausführungen und Candlestick-Daten für Backtesting oder Marktstrukturforschung.
|
||||
- **Überwachung:** Börsenweiten oder serienspezifischen Status prüfen, Echtzeit-Updates über Marktänderungen oder Handelsunterbrechungen erhalten und Reaktionen automatisieren.
|
||||
- **Automatisierungsbereit:** Entwicklung von End-to-End automatisierten Agenten und Dashboards, die Wahrscheinlichkeiten von Ereignissen in der realen Welt konsumieren, analysieren und damit handeln.
|
||||
|
||||
Durch die Nutzung dieser einheitlichen Tools und Endpunkte können Sie Kalshis Prognosemärkte, Live-Handelsfunktionen und umfangreiche Ereignisdaten nahtlos in Ihre KI-gestützten Anwendungen, Dashboards und Workflows integrieren – und so eine anspruchsvolle, automatisierte Entscheidungsfindung ermöglichen, die an reale Ergebnisse gekoppelt ist.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanleitung
|
||||
|
||||
Integrieren Sie Kalshi-Prognosemärkte in den Workflow. Kann Märkte, Markt, Ereignisse, Ereignis, Guthaben, Positionen, Aufträge, Orderbuch, Trades, Candlesticks, Ausführungen, Serien und Börsenstatus abrufen.
|
||||
|
||||
## Tools
|
||||
|
||||
### `kalshi_get_markets`
|
||||
|
||||
Rufe eine Liste von Prognosemärkten von Kalshi mit optionaler Filterung ab
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `status` | string | Nein | Nach Status filtern \(unopened, open, closed, settled\) |
|
||||
| `seriesTicker` | string | Nein | Nach Serien-Ticker filtern |
|
||||
| `eventTicker` | string | Nein | Nach Event-Ticker filtern |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse \(1-1000, standard: 100\) |
|
||||
| `cursor` | string | Nein | Paginierungscursor für die nächste Seite |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Marktdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_market`
|
||||
|
||||
Rufe Details eines bestimmten Prognosemarkts nach Ticker ab
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `ticker` | string | Ja | Der Markt-Ticker \(z.B. "KXBTC-24DEC31"\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Marktdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_events`
|
||||
|
||||
Rufe eine Liste von Events von Kalshi mit optionaler Filterung ab
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `status` | string | Nein | Nach Status filtern \(open, closed, settled\) |
|
||||
| `seriesTicker` | string | Nein | Nach Serien-Ticker filtern |
|
||||
| `withNestedMarkets` | string | Nein | Verschachtelte Märkte in der Antwort einschließen \(true/false\) |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse \(1-200, standard: 200\) |
|
||||
| `cursor` | string | Nein | Paginierungscursor für die nächste Seite |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Ereignisdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_event`
|
||||
|
||||
Details eines bestimmten Ereignisses anhand des Tickers abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `eventTicker` | string | Ja | Der Ereignis-Ticker |
|
||||
| `withNestedMarkets` | string | Nein | Verschachtelte Märkte in die Antwort einbeziehen \(true/false\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Ereignisdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_balance`
|
||||
|
||||
Kontostand und Portfoliowert von Kalshi abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Ja | Ihre Kalshi API-Schlüssel-ID |
|
||||
| `privateKey` | string | Ja | Ihr RSA Private Key \(PEM-Format\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Kontostandsdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_positions`
|
||||
|
||||
Offene Positionen von Kalshi abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Ja | Ihre Kalshi API-Schlüssel-ID |
|
||||
| `privateKey` | string | Ja | Ihr RSA Private Key \(PEM-Format\) |
|
||||
| `ticker` | string | Nein | Nach Markt-Ticker filtern |
|
||||
| `eventTicker` | string | Nein | Nach Ereignis-Ticker filtern \(max. 10 durch Komma getrennt\) |
|
||||
| `settlementStatus` | string | Nein | Nach Abrechnungsstatus filtern \(all, unsettled, settled\). Standard: unsettled |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse \(1-1000, Standard: 100\) |
|
||||
| `cursor` | string | Nein | Paginierungscursor für die nächste Seite |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Positionsdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_orders`
|
||||
|
||||
Rufen Sie Ihre Bestellungen von Kalshi mit optionaler Filterung ab
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Ja | Ihre Kalshi API-Schlüssel-ID |
|
||||
| `privateKey` | string | Ja | Ihr RSA Private Key \(PEM-Format\) |
|
||||
| `ticker` | string | Nein | Nach Markt-Ticker filtern |
|
||||
| `eventTicker` | string | Nein | Nach Event-Ticker filtern \(maximal 10 durch Komma getrennt\) |
|
||||
| `status` | string | Nein | Nach Status filtern \(resting, canceled, executed\) |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse \(1-200, Standard: 100\) |
|
||||
| `cursor` | string | Nein | Paginierungscursor für die nächste Seite |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Bestelldaten und Metadaten |
|
||||
|
||||
### `kalshi_get_orderbook`
|
||||
|
||||
Rufen Sie das Orderbuch (Gebote und Anfragen) für einen bestimmten Markt ab
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `ticker` | string | Ja | Markt-Ticker \(z.B. KXBTC-24DEC31\) |
|
||||
| `depth` | number | Nein | Anzahl der Preisstufen, die pro Seite zurückgegeben werden sollen |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Orderbuch-Daten und Metadaten |
|
||||
|
||||
### `kalshi_get_trades`
|
||||
|
||||
Ruft aktuelle Trades über alle Märkte oder für einen bestimmten Markt ab
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `ticker` | string | Nein | Nach Markt-Ticker filtern |
|
||||
| `minTs` | number | Nein | Minimaler Zeitstempel (Unix-Millisekunden) |
|
||||
| `maxTs` | number | Nein | Maximaler Zeitstempel (Unix-Millisekunden) |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse (1-1000, Standard: 100) |
|
||||
| `cursor` | string | Nein | Paginierungscursor für die nächste Seite |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Trade-Daten und Metadaten |
|
||||
|
||||
### `kalshi_get_candlesticks`
|
||||
|
||||
Ruft OHLC-Kerzendaten für einen bestimmten Markt ab
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `seriesTicker` | string | Ja | Serien-Ticker |
|
||||
| `ticker` | string | Ja | Markt-Ticker (z.B. KXBTC-24DEC31) |
|
||||
| `startTs` | number | Nein | Startzeitstempel (Unix-Millisekunden) |
|
||||
| `endTs` | number | Nein | Endzeitstempel (Unix-Millisekunden) |
|
||||
| `periodInterval` | number | Nein | Periodenintervall: 1 (1min), 60 (1std), oder 1440 (1tag) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Candlestick-Daten und Metadaten |
|
||||
|
||||
### `kalshi_get_fills`
|
||||
|
||||
Rufen Sie Ihr Portfolio ab
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Ja | Ihre Kalshi API-Schlüssel-ID |
|
||||
| `privateKey` | string | Ja | Ihr RSA Private Key \(PEM-Format\) |
|
||||
| `ticker` | string | Nein | Nach Markt-Ticker filtern |
|
||||
| `orderId` | string | Nein | Nach Auftrags-ID filtern |
|
||||
| `minTs` | number | Nein | Minimaler Zeitstempel \(Unix-Millisekunden\) |
|
||||
| `maxTs` | number | Nein | Maximaler Zeitstempel \(Unix-Millisekunden\) |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse \(1-1000, Standard: 100\) |
|
||||
| `cursor` | string | Nein | Paginierungscursor für die nächste Seite |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Ausführungsdaten und Metadaten |
|
||||
|
||||
### `kalshi_get_series_by_ticker`
|
||||
|
||||
Rufen Sie Details einer bestimmten Marktserie nach Ticker ab
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `seriesTicker` | string | Ja | Serien-Ticker |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Seriendaten und Metadaten |
|
||||
|
||||
### `kalshi_get_exchange_status`
|
||||
|
||||
Ruft den aktuellen Status der Kalshi-Börse ab (Handels- und Börsenaktivität)
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Börsenstatus-Daten und Metadaten |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `kalshi`
|
||||
83
apps/docs/content/docs/de/tools/linkedin.mdx
Normal file
83
apps/docs/content/docs/de/tools/linkedin.mdx
Normal file
@@ -0,0 +1,83 @@
|
||||
---
|
||||
title: LinkedIn
|
||||
description: Teilen Sie Beiträge und verwalten Sie Ihre LinkedIn-Präsenz
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="linkedin"
|
||||
color="#0072B1"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[LinkedIn](https://www.linkedin.com) ist die weltweit größte professionelle Netzwerkplattform, die Nutzern ermöglicht, ihre Karriere aufzubauen, sich mit ihrem Netzwerk zu verbinden und berufliche Inhalte zu teilen. LinkedIn wird von Fachleuten aus verschiedenen Branchen für persönliches Branding, Recruiting, Jobsuche und Geschäftsentwicklung genutzt.
|
||||
|
||||
Mit LinkedIn können Sie ganz einfach Beiträge in Ihrem persönlichen Feed teilen, um mit Ihrem Netzwerk in Kontakt zu treten, und auf Informationen über Ihr Profil zugreifen, um Ihre beruflichen Erfolge hervorzuheben. Die automatisierte Integration mit Sim ermöglicht es Ihnen, LinkedIn-Funktionen programmatisch zu nutzen – so können Agenten und Workflows Updates posten, über Ihre berufliche Präsenz berichten und Ihren Feed aktiv halten, ohne dass manuelle Arbeit erforderlich ist.
|
||||
|
||||
Zu den wichtigsten LinkedIn-Funktionen, die über diese Integration verfügbar sind, gehören:
|
||||
|
||||
- **Beiträge teilen:** Veröffentlichen Sie automatisch berufliche Updates, Artikel oder Ankündigungen in Ihrem persönlichen LinkedIn-Feed.
|
||||
- **Profilinformationen:** Rufen Sie detaillierte Informationen über Ihr LinkedIn-Profil ab, um diese zu überwachen oder in nachgelagerten Aufgaben innerhalb Ihrer Workflows zu verwenden.
|
||||
|
||||
Diese Funktionen machen es einfach, Ihr LinkedIn-Netzwerk zu pflegen und Ihre berufliche Reichweite effizient zu erweitern – als Teil Ihrer KI- oder Workflow-Automatisierungsstrategie.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanleitung
|
||||
|
||||
Integrieren Sie LinkedIn in Workflows. Teilen Sie Beiträge in Ihrem persönlichen Feed und greifen Sie auf Ihre LinkedIn-Profilinformationen zu.
|
||||
|
||||
## Tools
|
||||
|
||||
### `linkedin_share_post`
|
||||
|
||||
Einen Beitrag in Ihrem persönlichen LinkedIn-Feed teilen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `text` | string | Ja | Der Textinhalt Ihres LinkedIn-Beitrags |
|
||||
| `visibility` | string | Nein | Wer diesen Beitrag sehen kann: "PUBLIC" oder "CONNECTIONS" \(Standard: "PUBLIC"\) |
|
||||
| `request` | string | Nein | Keine Beschreibung |
|
||||
| `output` | string | Nein | Keine Beschreibung |
|
||||
| `output` | string | Nein | Keine Beschreibung |
|
||||
| `specificContent` | string | Nein | Keine Beschreibung |
|
||||
| `shareCommentary` | string | Nein | Keine Beschreibung |
|
||||
| `visibility` | string | Nein | Keine Beschreibung |
|
||||
| `headers` | string | Nein | Keine Beschreibung |
|
||||
| `output` | string | Nein | Keine Beschreibung |
|
||||
| `output` | string | Nein | Keine Beschreibung |
|
||||
| `output` | string | Nein | Keine Beschreibung |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `postId` | string | Erstellte Beitrags-ID |
|
||||
| `profile` | json | LinkedIn-Profilinformationen |
|
||||
| `error` | string | Fehlermeldung bei fehlgeschlagener Operation |
|
||||
|
||||
### `linkedin_get_profile`
|
||||
|
||||
Rufen Sie Ihre LinkedIn-Profilinformationen ab
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `postId` | string | Erstellte Beitrags-ID |
|
||||
| `profile` | json | LinkedIn-Profilinformationen |
|
||||
| `error` | string | Fehlermeldung bei fehlgeschlagener Operation |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `linkedin`
|
||||
216
apps/docs/content/docs/de/tools/mailgun.mdx
Normal file
216
apps/docs/content/docs/de/tools/mailgun.mdx
Normal file
@@ -0,0 +1,216 @@
|
||||
---
|
||||
title: Mailgun
|
||||
description: E-Mails versenden und Mailinglisten mit Mailgun verwalten
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="mailgun"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Mailgun](https://www.mailgun.com) ist ein leistungsstarker E-Mail-Zustelldienst, der für Entwickler und Unternehmen konzipiert wurde, um E-Mails mühelos zu versenden, zu empfangen und zu verfolgen. Mailgun ermöglicht es Ihnen, robuste APIs für zuverlässige Transaktions- und Marketing-E-Mails, flexible Mailinglisten-Verwaltung und fortschrittliches Event-Tracking zu nutzen.
|
||||
|
||||
Mit Mailguns umfassendem Funktionsumfang können Sie wichtige E-Mail-Operationen automatisieren und die Zustellbarkeit sowie das Engagement der Empfänger genau überwachen. Dies macht es zu einer idealen Lösung für Workflow-Automatisierung, bei der Kommunikation, Benachrichtigungen und Kampagnen-Mails zentrale Bestandteile Ihrer Prozesse sind.
|
||||
|
||||
Zu den wichtigsten Funktionen von Mailgun gehören:
|
||||
|
||||
- **Versand von Transaktions-E-Mails:** Zustellung von E-Mails mit hohem Volumen wie Kontobenachrichtigungen, Quittungen, Warnmeldungen und Passwort-Zurücksetzungen.
|
||||
- **Reichhaltige E-Mail-Inhalte:** Versenden Sie sowohl Nur-Text- als auch HTML-E-Mails und verwenden Sie Tags zur Kategorisierung und Verfolgung Ihrer Nachrichten.
|
||||
- **Mailinglisten-Verwaltung:** Erstellen, aktualisieren und verwalten Sie Mailinglisten und Mitglieder, um Gruppenkommunikation effizient zu versenden.
|
||||
- **Domain-Informationen:** Rufen Sie Details zu Ihren Sende-Domains ab, um Konfiguration und Zustand zu überwachen.
|
||||
- **Event-Tracking:** Analysieren Sie die Zustellbarkeit von E-Mails und das Engagement mit detaillierten Ereignisdaten zu gesendeten Nachrichten.
|
||||
- **Nachrichtenabruf:** Greifen Sie auf gespeicherte Nachrichten für Compliance-, Analyse- oder Fehlerbehebungszwecke zu.
|
||||
|
||||
Durch die Integration von Mailgun in Sim können Ihre Agenten programmatisch E-Mails versenden, E-Mail-Listen verwalten, auf Domain-Informationen zugreifen und Ereignisse in Echtzeit überwachen – als Teil automatisierter Workflows. Dies ermöglicht eine intelligente, datengesteuerte Interaktion mit Ihren Nutzern direkt aus Ihren KI-gestützten Prozessen heraus.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanleitung
|
||||
|
||||
Integrieren Sie Mailgun in Ihren Workflow. Senden Sie Transaktions-E-Mails, verwalten Sie Mailinglisten und Mitglieder, sehen Sie Domain-Informationen ein und verfolgen Sie E-Mail-Ereignisse. Unterstützt Text- und HTML-E-Mails, Tags für Tracking und umfassende Listenverwaltung.
|
||||
|
||||
## Tools
|
||||
|
||||
### `mailgun_send_message`
|
||||
|
||||
E-Mail über die Mailgun API versenden
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Mailgun API-Schlüssel |
|
||||
| `domain` | string | Ja | Mailgun-Domain \(z.B. mg.example.com\) |
|
||||
| `from` | string | Ja | E-Mail-Adresse des Absenders |
|
||||
| `to` | string | Ja | E-Mail-Adresse des Empfängers \(durch Komma getrennt für mehrere\) |
|
||||
| `subject` | string | Ja | Betreff der E-Mail |
|
||||
| `text` | string | Nein | Nur-Text-Inhalt der E-Mail |
|
||||
| `html` | string | Nein | HTML-Inhalt der E-Mail |
|
||||
| `cc` | string | Nein | CC-E-Mail-Adresse \(durch Komma getrennt für mehrere\) |
|
||||
| `bcc` | string | Nein | BCC-E-Mail-Adresse \(durch Komma getrennt für mehrere\) |
|
||||
| `tags` | string | Nein | Tags für die E-Mail \(durch Komma getrennt\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die Nachricht erfolgreich gesendet wurde |
|
||||
| `id` | string | Nachrichten-ID |
|
||||
| `message` | string | Antwortnachricht von Mailgun |
|
||||
|
||||
### `mailgun_get_message`
|
||||
|
||||
Eine gespeicherte Nachricht anhand ihres Schlüssels abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Mailgun API-Schlüssel |
|
||||
| `domain` | string | Ja | Mailgun-Domain |
|
||||
| `messageKey` | string | Ja | Speicherschlüssel der Nachricht |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die Anfrage erfolgreich war |
|
||||
| `recipients` | string | Nachrichtenempfänger |
|
||||
| `from` | string | Absender-E-Mail |
|
||||
| `subject` | string | Nachrichtenbetreff |
|
||||
| `bodyPlain` | string | Nur-Text-Inhalt |
|
||||
| `strippedText` | string | Bereinigter Text |
|
||||
| `strippedSignature` | string | Bereinigte Signatur |
|
||||
| `bodyHtml` | string | HTML-Inhalt |
|
||||
| `strippedHtml` | string | Bereinigtes HTML |
|
||||
| `attachmentCount` | number | Anzahl der Anhänge |
|
||||
| `timestamp` | number | Nachrichtenzeitstempel |
|
||||
| `messageHeaders` | json | Nachrichtenheader |
|
||||
| `contentIdMap` | json | Content-ID-Zuordnung |
|
||||
|
||||
### `mailgun_list_messages`
|
||||
|
||||
Ereignisse (Logs) für über Mailgun gesendete Nachrichten auflisten
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Mailgun API-Schlüssel |
|
||||
| `domain` | string | Ja | Mailgun-Domain |
|
||||
| `event` | string | Nein | Nach Ereignistyp filtern \(accepted, delivered, failed, opened, clicked, usw.\) |
|
||||
| `limit` | number | Nein | Maximale Anzahl der zurückzugebenden Ereignisse \(Standard: 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die Anfrage erfolgreich war |
|
||||
| `items` | json | Array von Ereigniselementen |
|
||||
| `paging` | json | Paginierungsinformationen |
|
||||
|
||||
### `mailgun_create_mailing_list`
|
||||
|
||||
Eine neue Mailingliste erstellen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Mailgun API-Schlüssel |
|
||||
| `address` | string | Ja | Mailinglisten-Adresse \(z.B. liste@beispiel.com\) |
|
||||
| `name` | string | Nein | Name der Mailingliste |
|
||||
| `description` | string | Nein | Beschreibung der Mailingliste |
|
||||
| `accessLevel` | string | Nein | Zugriffsebene: readonly, members oder everyone |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die Liste erfolgreich erstellt wurde |
|
||||
| `message` | string | Antwortnachricht |
|
||||
| `list` | json | Details der erstellten Mailingliste |
|
||||
|
||||
### `mailgun_get_mailing_list`
|
||||
|
||||
Details einer Mailingliste abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Mailgun API-Schlüssel |
|
||||
| `address` | string | Ja | Mailinglisten-Adresse |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die Anfrage erfolgreich war |
|
||||
| `list` | json | Details der Mailingliste |
|
||||
|
||||
### `mailgun_add_list_member`
|
||||
|
||||
Ein Mitglied zu einer Mailingliste hinzufügen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Mailgun API-Schlüssel |
|
||||
| `listAddress` | string | Ja | Mailinglisten-Adresse |
|
||||
| `address` | string | Ja | E-Mail-Adresse des Mitglieds |
|
||||
| `name` | string | Nein | Name des Mitglieds |
|
||||
| `vars` | string | Nein | JSON-String mit benutzerdefinierten Variablen |
|
||||
| `subscribed` | boolean | Nein | Ob das Mitglied abonniert ist |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob das Mitglied erfolgreich hinzugefügt wurde |
|
||||
| `message` | string | Antwortnachricht |
|
||||
| `member` | json | Details des hinzugefügten Mitglieds |
|
||||
|
||||
### `mailgun_list_domains`
|
||||
|
||||
Alle Domains für Ihr Mailgun-Konto auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Mailgun API-Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die Anfrage erfolgreich war |
|
||||
| `totalCount` | number | Gesamtanzahl der Domains |
|
||||
| `items` | json | Array von Domain-Objekten |
|
||||
|
||||
### `mailgun_get_domain`
|
||||
|
||||
Details einer bestimmten Domain abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | Mailgun API-Schlüssel |
|
||||
| `domain` | string | Ja | Domainname |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die Anfrage erfolgreich war |
|
||||
| `domain` | json | Domain-Details |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `mailgun`
|
||||
352
apps/docs/content/docs/de/tools/polymarket.mdx
Normal file
352
apps/docs/content/docs/de/tools/polymarket.mdx
Normal file
@@ -0,0 +1,352 @@
|
||||
---
|
||||
title: Polymarket
|
||||
description: Zugriff auf Prognosemarktdaten von Polymarket
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="polymarket"
|
||||
color="#4C82FB"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Polymarket](https://polymarket.com) ist eine dezentralisierte Plattform für Prognosemärkte, auf der Nutzer mit Blockchain-Technologie auf den Ausgang zukünftiger Ereignisse handeln können. Polymarket bietet eine umfassende API, die Entwicklern und Agenten den Zugriff auf Live-Marktdaten, Ereignislisten, Preisinformationen und Orderbuch-Statistiken ermöglicht, um datengesteuerte Workflows und KI-Automatisierungen zu unterstützen.
|
||||
|
||||
Mit der API von Polymarket und der Sim-Integration können Sie Agenten befähigen, programmatisch Informationen zu Prognosemärkten abzurufen, offene Märkte und zugehörige Ereignisse zu erkunden, historische Preisdaten zu analysieren und auf Orderbücher und Markt-Mittelwerte zuzugreifen. Dies schafft neue Möglichkeiten für Recherchen, automatisierte Analysen und die Entwicklung intelligenter Agenten, die auf Echtzeit-Ereigniswahrscheinlichkeiten reagieren, die aus Marktpreisen abgeleitet werden.
|
||||
|
||||
Zu den wichtigsten Funktionen der Polymarket-Integration gehören:
|
||||
|
||||
- **Marktlisting & Filterung:** Auflistung aller aktuellen oder historischen Prognosemärkte, Filterung nach Tags, Sortierung und Seitenweise Durchblättern der Ergebnisse.
|
||||
- **Marktdetails:** Abrufen von Details für einen einzelnen Markt anhand der Markt-ID oder des Slugs, einschließlich seiner Ergebnisse und Status.
|
||||
- **Ereignislisten:** Zugriff auf Listen von Polymarket-Ereignissen und detaillierte Ereignisinformationen.
|
||||
- **Orderbuch- & Preisdaten:** Analyse des Orderbuchs, Abruf der aktuellen Marktpreise, Einsicht in den Mittelwert oder Erhalt historischer Preisinformationen für jeden Markt.
|
||||
- **Automatisierungsbereit:** Erstellen von Agenten oder Tools, die programmatisch auf Marktentwicklungen, sich ändernde Quoten oder bestimmte Ereignisausgänge reagieren.
|
||||
|
||||
Durch die Nutzung dieser dokumentierten API-Endpunkte können Sie die umfangreichen On-Chain-Prognosemarktdaten von Polymarket nahtlos in Ihre eigenen KI-Workflows, Dashboards, Recherchetools und Handelsautomatisierungen integrieren.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanweisungen
|
||||
|
||||
Integrieren Sie Polymarket-Prognosemärkte in den Workflow. Kann Märkte, Markt, Ereignisse, Ereignis, Tags, Serien, Orderbuch, Preis, Mittelpunkt, Preisverlauf, letzten Handelspreis, Spread, Tick-Größe, Positionen, Trades und Suche abrufen.
|
||||
|
||||
## Tools
|
||||
|
||||
### `polymarket_get_markets`
|
||||
|
||||
Rufen Sie eine Liste von Prognosemärkten von Polymarket mit optionaler Filterung ab
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `closed` | string | Nein | Nach geschlossenem Status filtern \(true/false\). Verwenden Sie false für nur aktive Märkte. |
|
||||
| `order` | string | Nein | Sortierfeld \(z.B. id, volume, liquidity\) |
|
||||
| `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 \(empfohlen: 25-50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe so viele Ergebnisse\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Marktdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_market`
|
||||
|
||||
Rufen Sie Details eines bestimmten Prognosemarktes nach ID oder Slug ab
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `marketId` | string | Nein | Die Markt-ID. Erforderlich, wenn Slug nicht angegeben wird. |
|
||||
| `slug` | string | Nein | Der Markt-Slug \(z.B. "will-trump-win"\). Erforderlich, wenn marketId nicht angegeben wird. |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Marktdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_events`
|
||||
|
||||
Ruft eine Liste von Events von Polymarket mit optionaler Filterung ab
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `closed` | string | Nein | Filtern nach geschlossenem Status \(true/false\). Verwenden Sie false für nur aktive Events. |
|
||||
| `order` | string | Nein | Sortierfeld \(z.B. id, volume\) |
|
||||
| `ascending` | string | Nein | Sortierrichtung \(true für aufsteigend, false für absteigend\) |
|
||||
| `tagId` | string | Nein | Filtern nach Tag-ID |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(empfohlen: 25-50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe so viele Ergebnisse\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Event-Daten und Metadaten |
|
||||
|
||||
### `polymarket_get_event`
|
||||
|
||||
Ruft Details eines bestimmten Events nach ID oder Slug ab
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `eventId` | string | Nein | Die Event-ID. Erforderlich, wenn kein Slug angegeben wird. |
|
||||
| `slug` | string | Nein | Der Event-Slug \(z.B. "2024-presidential-election"\). Erforderlich, wenn keine eventId angegeben wird. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Ereignisdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_tags`
|
||||
|
||||
Verfügbare Tags zum Filtern von Märkten von Polymarket abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(empfohlen: 25-50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe diese Anzahl an Ergebnissen\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Tag-Daten und Metadaten |
|
||||
|
||||
### `polymarket_search`
|
||||
|
||||
Nach Märkten, Ereignissen und Profilen auf Polymarket suchen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Ja | Suchbegriff |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(empfohlen: 25-50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe diese Anzahl an Ergebnissen\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Suchergebnisse und Metadaten |
|
||||
|
||||
### `polymarket_get_series`
|
||||
|
||||
Serien (verwandte Marktgruppen) von Polymarket abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | Nein | Anzahl der Ergebnisse pro Seite \(empfohlen: 25-50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe diese Anzahl an Ergebnissen\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Seriendaten und Metadaten |
|
||||
|
||||
### `polymarket_get_series_by_id`
|
||||
|
||||
Eine bestimmte Serie (zugehörige Marktgruppe) anhand der ID von Polymarket abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `seriesId` | string | Ja | Die Serien-ID |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Seriendaten und Metadaten |
|
||||
|
||||
### `polymarket_get_orderbook`
|
||||
|
||||
Die Orderbuch-Zusammenfassung für einen bestimmten Token abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Ja | Die CLOB-Token-ID (aus den clobTokenIds des Marktes) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Orderbuch-Daten und Metadaten |
|
||||
|
||||
### `polymarket_get_price`
|
||||
|
||||
Den Marktpreis für einen bestimmten Token und eine bestimmte Seite abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Ja | Die CLOB-Token-ID (aus den clobTokenIds des Marktes) |
|
||||
| `side` | string | Ja | Orderseite: buy oder sell |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Preisdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_midpoint`
|
||||
|
||||
Abrufen des Mittelpreises für einen bestimmten Token
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Ja | Die CLOB-Token-ID (aus market clobTokenIds) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Mittelpreisdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_price_history`
|
||||
|
||||
Abrufen historischer Preisdaten für einen bestimmten Markttoken
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Ja | Die CLOB-Token-ID (aus market clobTokenIds) |
|
||||
| `interval` | string | Nein | Zeitraum, der zum aktuellen Zeitpunkt endet (1m, 1h, 6h, 1d, 1w, max). Schließt sich gegenseitig mit startTs/endTs aus. |
|
||||
| `fidelity` | number | Nein | Datenauflösung in Minuten (z.B. 60 für stündlich) |
|
||||
| `startTs` | number | Nein | Startzeitstempel (Unix-Sekunden UTC) |
|
||||
| `endTs` | number | Nein | Endzeitstempel (Unix-Sekunden UTC) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Preisverlaufsdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_last_trade_price`
|
||||
|
||||
Den letzten Handelspreis für einen bestimmten Token abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Ja | Die CLOB-Token-ID \(aus market clobTokenIds\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Letzter Handelspreis und Metadaten |
|
||||
|
||||
### `polymarket_get_spread`
|
||||
|
||||
Die Geld-Brief-Spanne für einen bestimmten Token abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Ja | Die CLOB-Token-ID \(aus market clobTokenIds\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Spread-Daten und Metadaten |
|
||||
|
||||
### `polymarket_get_tick_size`
|
||||
|
||||
Die minimale Tickgröße für einen bestimmten Token abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Ja | Die CLOB-Token-ID \(aus market clobTokenIds\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Status des Operationserfolgs |
|
||||
| `output` | object | Tickgröße und Metadaten |
|
||||
|
||||
### `polymarket_get_positions`
|
||||
|
||||
Benutzerpositionen von Polymarket abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `user` | string | Ja | Wallet-Adresse des Benutzers |
|
||||
| `market` | string | Nein | Optionale Markt-ID zum Filtern von Positionen |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Positionsdaten und Metadaten |
|
||||
|
||||
### `polymarket_get_trades`
|
||||
|
||||
Handelshistorie von Polymarket abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `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 \(empfohlen: 25-50\) |
|
||||
| `offset` | string | Nein | Paginierungsoffset \(überspringe so viele Ergebnisse\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `output` | object | Handelsdaten und Metadaten |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `polymarket`
|
||||
@@ -83,10 +83,17 @@ Ein neues Anliegen mit bestimmten Eigenschaften erstellen
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiToken` | string | Ja | Pylon API-Token |
|
||||
| `title` | string | Ja | Titel des Anliegens |
|
||||
| `bodyHtml` | string | Ja | Inhalt des Anliegens im HTML-Format |
|
||||
| `accountId` | string | Nein | Konto-ID, die mit dem Anliegen verknüpft werden soll |
|
||||
| `assigneeId` | string | Nein | Benutzer-ID, der das Anliegen zugewiesen werden soll |
|
||||
| `title` | string | Ja | Titel des Problems |
|
||||
| `bodyHtml` | string | Ja | Inhalt des Problems im HTML-Format |
|
||||
| `accountId` | string | Nein | Konto-ID, die mit dem Problem verknüpft werden soll |
|
||||
| `assigneeId` | string | Nein | Benutzer-ID, der das Problem zugewiesen werden soll |
|
||||
| `teamId` | string | Nein | Team-ID, dem das Problem zugewiesen werden soll |
|
||||
| `requesterId` | string | Nein | Anforderer-Benutzer-ID \(Alternative zu requester_email\) |
|
||||
| `requesterEmail` | string | Nein | E-Mail-Adresse des Anforderers \(Alternative zu requester_id\) |
|
||||
| `priority` | string | Nein | Priorität des Problems |
|
||||
| `tags` | string | Nein | Durch Komma getrennte Tag-IDs |
|
||||
| `customFields` | string | Nein | Benutzerdefinierte Felder als JSON-Objekt |
|
||||
| `attachmentUrls` | string | Nein | Durch Komma getrennte Anhang-URLs |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -119,15 +126,18 @@ Aktualisiert ein bestehendes Issue
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiToken` | string | Ja | Pylon API-Token |
|
||||
| `issueId` | string | Ja | Die ID des zu aktualisierenden Issues |
|
||||
| `state` | string | Nein | Issue-Status |
|
||||
| `assigneeId` | string | Nein | Benutzer-ID, der das Issue zugewiesen werden soll |
|
||||
| `teamId` | string | Nein | Team-ID, dem das Issue zugewiesen werden soll |
|
||||
| `tags` | string | Nein | Kommagetrennte Tag-IDs |
|
||||
| `issueId` | string | Ja | Die ID des zu aktualisierenden Problems |
|
||||
| `state` | string | Nein | Status des Problems |
|
||||
| `assigneeId` | string | Nein | Benutzer-ID, der das Problem zugewiesen werden soll |
|
||||
| `teamId` | string | Nein | Team-ID, dem das Problem zugewiesen werden soll |
|
||||
| `tags` | string | Nein | Durch Komma getrennte Tag-IDs |
|
||||
| `customFields` | string | Nein | Benutzerdefinierte Felder als JSON-Objekt |
|
||||
| `customerPortalVisible` | boolean | Nein | Ob das Problem im Kundenportal sichtbar ist |
|
||||
| `requesterId` | string | Nein | Anforderer-Benutzer-ID |
|
||||
| `accountId` | string | Nein | Konto-ID, die mit dem Problem verknüpft werden soll |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
168
apps/docs/content/docs/de/tools/rds.mdx
Normal file
168
apps/docs/content/docs/de/tools/rds.mdx
Normal file
@@ -0,0 +1,168 @@
|
||||
---
|
||||
title: Amazon RDS
|
||||
description: Verbindung zu Amazon RDS über Data API
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="rds"
|
||||
color="linear-gradient(45deg, #2E27AD 0%, #527FFF 100%)"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Amazon RDS Aurora Serverless](https://aws.amazon.com/rds/aurora/serverless/) ist eine vollständig verwaltete relationale Datenbank, die automatisch startet, herunterfährt und ihre Kapazität basierend auf den Anforderungen Ihrer Anwendung skaliert. Sie ermöglicht es Ihnen, SQL-Datenbanken in der Cloud zu betreiben, ohne Datenbankserver verwalten zu müssen.
|
||||
|
||||
Mit RDS Aurora Serverless können Sie:
|
||||
|
||||
- **Daten abfragen**: Flexible SQL-Abfragen über Ihre Tabellen ausführen
|
||||
- **Neue Datensätze einfügen**: Automatisch Daten zu Ihrer Datenbank hinzufügen
|
||||
- **Bestehende Datensätze aktualisieren**: Daten in Ihren Tabellen mit benutzerdefinierten Filtern ändern
|
||||
- **Datensätze löschen**: Unerwünschte Daten mit präzisen Kriterien entfernen
|
||||
- **Raw-SQL ausführen**: Jeden gültigen SQL-Befehl ausführen, der von Aurora unterstützt wird
|
||||
|
||||
In Sim ermöglicht die RDS-Integration Ihren Agenten, sicher und programmatisch mit Amazon Aurora Serverless-Datenbanken zu arbeiten. Zu den unterstützten Operationen gehören:
|
||||
|
||||
- **Abfrage**: SELECT und andere SQL-Abfragen ausführen, um Zeilen aus Ihrer Datenbank abzurufen
|
||||
- **Einfügen**: Neue Datensätze mit strukturierten Daten in Tabellen einfügen
|
||||
- **Aktualisieren**: Daten in Zeilen ändern, die Ihren angegebenen Bedingungen entsprechen
|
||||
- **Löschen**: Datensätze aus einer Tabelle nach benutzerdefinierten Filtern oder Kriterien entfernen
|
||||
- **Ausführen**: Raw-SQL für fortgeschrittene Szenarien ausführen
|
||||
|
||||
Diese Integration ermöglicht es Ihren Agenten, eine breite Palette von Datenbankoperationen ohne manuelle Eingriffe zu automatisieren. Durch die Verbindung von Sim mit Amazon RDS können Sie Agenten erstellen, die relationale Daten innerhalb Ihrer Workflows verwalten, aktualisieren und abrufen – alles ohne Datenbankinfrastruktur oder -verbindungen zu verwalten.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanweisungen
|
||||
|
||||
Integrieren Sie Amazon RDS Aurora Serverless in den Workflow mit der Data API. Kann Daten abfragen, einfügen, aktualisieren, löschen und Raw-SQL ausführen, ohne Datenbankverbindungen verwalten zu müssen.
|
||||
|
||||
## Tools
|
||||
|
||||
### `rds_query`
|
||||
|
||||
Führen Sie eine SELECT-Abfrage auf Amazon RDS mit der Data API aus
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Ja | AWS-Region (z.B. us-east-1) |
|
||||
| `accessKeyId` | string | Ja | AWS-Zugriffsschlüssel-ID |
|
||||
| `secretAccessKey` | string | Ja | AWS-Geheimzugriffsschlüssel |
|
||||
| `resourceArn` | string | Ja | ARN des Aurora-DB-Clusters |
|
||||
| `secretArn` | string | Ja | ARN des Secrets Manager-Geheimnisses mit DB-Anmeldedaten |
|
||||
| `database` | string | Nein | Datenbankname (optional) |
|
||||
| `query` | string | Ja | SQL-SELECT-Abfrage zur Ausführung |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
| `rows` | array | Array der zurückgegebenen Zeilen aus der Abfrage |
|
||||
| `rowCount` | number | Anzahl der zurückgegebenen Zeilen |
|
||||
|
||||
### `rds_insert`
|
||||
|
||||
Daten in eine Amazon RDS-Tabelle mit der Data API einfügen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Ja | AWS-Region (z.B. us-east-1) |
|
||||
| `accessKeyId` | string | Ja | AWS-Zugriffsschlüssel-ID |
|
||||
| `secretAccessKey` | string | Ja | AWS-Geheimzugriffsschlüssel |
|
||||
| `resourceArn` | string | Ja | ARN des Aurora-DB-Clusters |
|
||||
| `secretArn` | string | Ja | ARN des Secrets Manager-Geheimnisses mit DB-Anmeldedaten |
|
||||
| `database` | string | Nein | Datenbankname (optional) |
|
||||
| `table` | string | Ja | Tabellenname zum Einfügen |
|
||||
| `data` | object | Ja | Einzufügende Daten als Schlüssel-Wert-Paare |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
| `rows` | array | Array der eingefügten Zeilen |
|
||||
| `rowCount` | number | Anzahl der eingefügten Zeilen |
|
||||
|
||||
### `rds_update`
|
||||
|
||||
Daten in einer Amazon RDS-Tabelle über die Data API aktualisieren
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Ja | AWS-Region (z.B. us-east-1) |
|
||||
| `accessKeyId` | string | Ja | AWS-Zugriffsschlüssel-ID |
|
||||
| `secretAccessKey` | string | Ja | AWS-Geheimzugriffsschlüssel |
|
||||
| `resourceArn` | string | Ja | ARN des Aurora-DB-Clusters |
|
||||
| `secretArn` | string | Ja | ARN des Secrets Manager-Geheimnisses mit DB-Anmeldedaten |
|
||||
| `database` | string | Nein | Datenbankname (optional) |
|
||||
| `table` | string | Ja | Name der zu aktualisierenden Tabelle |
|
||||
| `data` | object | Ja | Zu aktualisierende Daten als Schlüssel-Wert-Paare |
|
||||
| `conditions` | object | Ja | Bedingungen für die Aktualisierung (z.B. `{"id": 1}`) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
| `rows` | array | Array der aktualisierten Zeilen |
|
||||
| `rowCount` | number | Anzahl der aktualisierten Zeilen |
|
||||
|
||||
### `rds_delete`
|
||||
|
||||
Daten aus einer Amazon RDS-Tabelle über die Data API löschen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Ja | AWS-Region (z.B. us-east-1) |
|
||||
| `accessKeyId` | string | Ja | AWS-Zugriffsschlüssel-ID |
|
||||
| `secretAccessKey` | string | Ja | AWS geheimer Zugriffsschlüssel |
|
||||
| `resourceArn` | string | Ja | ARN des Aurora-DB-Clusters |
|
||||
| `secretArn` | string | Ja | ARN des Secrets Manager-Geheimnisses mit DB-Anmeldedaten |
|
||||
| `database` | string | Nein | Datenbankname (optional) |
|
||||
| `table` | string | Ja | Tabellenname, aus dem gelöscht werden soll |
|
||||
| `conditions` | object | Ja | Bedingungen für das Löschen (z.B. `{"id": 1}`) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
| `rows` | array | Array der gelöschten Zeilen |
|
||||
| `rowCount` | number | Anzahl der gelöschten Zeilen |
|
||||
|
||||
### `rds_execute`
|
||||
|
||||
Rohes SQL auf Amazon RDS über die Data API ausführen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Ja | AWS-Region (z.B. us-east-1) |
|
||||
| `accessKeyId` | string | Ja | AWS-Zugriffsschlüssel-ID |
|
||||
| `secretAccessKey` | string | Ja | AWS geheimer Zugriffsschlüssel |
|
||||
| `resourceArn` | string | Ja | ARN des Aurora-DB-Clusters |
|
||||
| `secretArn` | string | Ja | ARN des Secrets Manager-Geheimnisses mit DB-Anmeldedaten |
|
||||
| `database` | string | Nein | Datenbankname (optional) |
|
||||
| `query` | string | Ja | Rohe SQL-Abfrage zur Ausführung |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
| `rows` | array | Array der zurückgegebenen oder betroffenen Zeilen |
|
||||
| `rowCount` | number | Anzahl der betroffenen Zeilen |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `rds`
|
||||
@@ -7,7 +7,7 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="s3"
|
||||
color="#E0E0E0"
|
||||
color="linear-gradient(45deg, #1B660F 0%, #6CAE3E 100%)"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
|
||||
54
apps/docs/content/docs/de/tools/search.mdx
Normal file
54
apps/docs/content/docs/de/tools/search.mdx
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: Suche
|
||||
description: Durchsuche das Web (0,01 $ pro Suche)
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="search"
|
||||
color="#3B82F6"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
Das **Suche**-Tool ermöglicht es dir, das Web innerhalb deiner Sim-Workflows mit hochmodernen Suchmaschinen zu durchsuchen. Nutze es, um die neuesten Informationen, Nachrichten, Fakten und Webinhalte direkt in deine Agenten, Automatisierungen oder Gespräche einzubinden.
|
||||
|
||||
- **Allgemeine Websuche**: Finde aktuelle Informationen aus dem Internet, um deine Workflows zu ergänzen.
|
||||
- **Automatisierte Abfragen**: Lass Agenten oder Programmlogik Suchanfragen stellen und die Ergebnisse automatisch verarbeiten.
|
||||
- **Strukturierte Ergebnisse**: Liefert die relevantesten Webergebnisse, einschließlich Titel, Link, Textauszug und Datum für jedes Ergebnis.
|
||||
|
||||
> **Hinweis:** Jede Suche kostet **0,01 $** pro Anfrage.
|
||||
|
||||
Dieses Tool ist ideal für jeden Workflow, bei dem deine Agenten Zugriff auf aktuelle Webdaten benötigen oder auf aktuelle Ereignisse verweisen, Recherchen durchführen oder ergänzende Inhalte abrufen müssen.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanleitung
|
||||
|
||||
Durchsuche das Web mit dem Suche-Tool. Jede Suche kostet 0,01 $ pro Anfrage.
|
||||
|
||||
## Tools
|
||||
|
||||
### `search_tool`
|
||||
|
||||
Durchsuche das Web. Liefert die relevantesten Webergebnisse, einschließlich Titel, Link, Textauszug und Datum für jedes Ergebnis.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Ja | Die Suchanfrage |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | json | Suchergebnisse |
|
||||
| `query` | string | Die Suchanfrage |
|
||||
| `totalResults` | number | Gesamtzahl der Ergebnisse |
|
||||
| `source` | string | Suchquelle \(exa\) |
|
||||
| `cost` | json | Kosteninformationen \(0,01 $\) |
|
||||
|
||||
## Notizen
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `search`
|
||||
391
apps/docs/content/docs/de/tools/sendgrid.mdx
Normal file
391
apps/docs/content/docs/de/tools/sendgrid.mdx
Normal file
@@ -0,0 +1,391 @@
|
||||
---
|
||||
title: SendGrid
|
||||
description: Senden Sie E-Mails und verwalten Sie Kontakte, Listen und Vorlagen mit SendGrid
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="sendgrid"
|
||||
color="#1A82E2"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[SendGrid](https://sendgrid.com) ist eine führende cloudbasierte E-Mail-Zustellplattform, der Entwickler und Unternehmen vertrauen, um zuverlässige Transaktions- und Marketing-E-Mails in großem Umfang zu versenden. Mit seinen robusten APIs und leistungsstarken Tools ermöglicht SendGrid die Verwaltung aller Aspekte Ihrer E-Mail-Kommunikation, vom Versenden von Benachrichtigungen und Quittungen bis hin zur Verwaltung komplexer Marketingkampagnen.
|
||||
|
||||
SendGrid bietet Benutzern eine vollständige Suite von E-Mail-Funktionen, mit denen Sie kritische E-Mail-Workflows automatisieren und Kontaktlisten, Vorlagen und Empfängerengagement genau verwalten können. Die nahtlose Integration mit Sim ermöglicht es Agenten und Workflows, gezielte Nachrichten zu versenden, dynamische Kontakt- und Empfängerlisten zu pflegen, personalisierte E-Mails über Vorlagen auszulösen und die Ergebnisse in Echtzeit zu verfolgen.
|
||||
|
||||
Zu den wichtigsten Funktionen von SendGrid gehören:
|
||||
|
||||
- **Transaktions-E-Mails:** Versenden Sie automatisierte und umfangreiche Transaktions-E-Mails (wie Benachrichtigungen, Quittungen und Passwort-Zurücksetzungen).
|
||||
- **Dynamische Vorlagen:** Verwenden Sie umfangreiche HTML- oder Textvorlagen mit dynamischen Daten für hochpersonalisierte Kommunikation im großen Maßstab.
|
||||
- **Kontaktverwaltung:** Fügen Sie Marketing-Kontakte hinzu und aktualisieren Sie diese, verwalten Sie Empfängerlisten und Zielsegmente für Kampagnen.
|
||||
- **Unterstützung für Anhänge:** Fügen Sie Ihren E-Mails einen oder mehrere Dateianhänge hinzu.
|
||||
- **Umfassende API-Abdeckung:** Verwalten Sie E-Mails, Kontakte, Listen, Vorlagen, Unterdrückungsgruppen und mehr programmatisch.
|
||||
|
||||
Durch die Verbindung von SendGrid mit Sim können Ihre Agenten:
|
||||
|
||||
- Sowohl einfache als auch fortgeschrittene (vorlagenbasierte oder an mehrere Empfänger gerichtete) E-Mails als Teil eines beliebigen Workflows versenden.
|
||||
- Kontakte und Listen automatisch verwalten und segmentieren.
|
||||
- Vorlagen für Konsistenz und dynamische Personalisierung nutzen.
|
||||
- E-Mail-Engagement innerhalb Ihrer automatisierten Prozesse verfolgen und darauf reagieren.
|
||||
|
||||
Diese Integration ermöglicht es Ihnen, alle kritischen Kommunikationsabläufe zu automatisieren, sicherzustellen, dass Nachrichten die richtige Zielgruppe erreichen, und die Kontrolle über die E-Mail-Strategie Ihrer Organisation direkt aus Sim-Workflows zu behalten.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanleitung
|
||||
|
||||
Integrieren Sie SendGrid in Ihren Workflow. Senden Sie transaktionale E-Mails, verwalten Sie Marketing-Kontakte und -Listen und arbeiten Sie mit E-Mail-Vorlagen. Unterstützt dynamische Vorlagen, Anhänge und umfassendes Kontaktmanagement.
|
||||
|
||||
## Tools
|
||||
|
||||
### `sendgrid_send_mail`
|
||||
|
||||
Eine E-Mail über die SendGrid API senden
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `from` | string | Ja | E-Mail-Adresse des Absenders \(muss in SendGrid verifiziert sein\) |
|
||||
| `fromName` | string | Nein | Name des Absenders |
|
||||
| `to` | string | Ja | E-Mail-Adresse des Empfängers |
|
||||
| `toName` | string | Nein | Name des Empfängers |
|
||||
| `subject` | string | Nein | E-Mail-Betreff \(erforderlich, es sei denn, es wird eine Vorlage mit vordefiniertem Betreff verwendet\) |
|
||||
| `content` | string | Nein | E-Mail-Inhalt \(erforderlich, es sei denn, es wird eine Vorlage mit vordefiniertem Inhalt verwendet\) |
|
||||
| `contentType` | string | Nein | Inhaltstyp \(text/plain oder text/html\) |
|
||||
| `cc` | string | Nein | CC E-Mail-Adresse |
|
||||
| `bcc` | string | Nein | BCC E-Mail-Adresse |
|
||||
| `replyTo` | string | Nein | Antwort-an E-Mail-Adresse |
|
||||
| `replyToName` | string | Nein | Antwort-an Name |
|
||||
| `attachments` | file[] | Nein | Dateien, die der E-Mail angehängt werden sollen |
|
||||
| `templateId` | string | Nein | Zu verwendende SendGrid-Vorlagen-ID |
|
||||
| `dynamicTemplateData` | json | Nein | JSON-Objekt mit dynamischen Vorlagendaten |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die E-Mail erfolgreich gesendet wurde |
|
||||
| `messageId` | string | SendGrid-Nachrichten-ID |
|
||||
| `to` | string | E-Mail-Adresse des Empfängers |
|
||||
| `subject` | string | E-Mail-Betreff |
|
||||
|
||||
### `sendgrid_add_contact`
|
||||
|
||||
Einen neuen Kontakt zu SendGrid hinzufügen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `email` | string | Ja | E-Mail-Adresse des Kontakts |
|
||||
| `firstName` | string | Nein | Vorname des Kontakts |
|
||||
| `lastName` | string | Nein | Nachname des Kontakts |
|
||||
| `customFields` | json | Nein | JSON-Objekt mit benutzerdefinierten Feld-Schlüssel-Wert-Paaren \(verwende Feld-IDs wie e1_T, e2_N, e3_D, nicht Feldnamen\) |
|
||||
| `listIds` | string | Nein | Kommagetrennte Listen-IDs, zu denen der Kontakt hinzugefügt werden soll |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobId` | string | Job-ID zur Verfolgung der asynchronen Kontakterstellung |
|
||||
| `email` | string | E-Mail-Adresse des Kontakts |
|
||||
| `firstName` | string | Vorname des Kontakts |
|
||||
| `lastName` | string | Nachname des Kontakts |
|
||||
| `message` | string | Statusmeldung |
|
||||
|
||||
### `sendgrid_get_contact`
|
||||
|
||||
Einen bestimmten Kontakt anhand der ID von SendGrid abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `contactId` | string | Ja | Kontakt-ID |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Kontakt-ID |
|
||||
| `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 |
|
||||
|
||||
### `sendgrid_search_contacts`
|
||||
|
||||
Suche nach Kontakten in SendGrid mit einer Abfrage
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `query` | string | Ja | Suchabfrage (z.B. "email LIKE '%example.com%' AND CONTAINS(list_ids, 'list-id')") |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contacts` | json | Array übereinstimmender Kontakte |
|
||||
| `contactCount` | number | Gesamtzahl der gefundenen Kontakte |
|
||||
|
||||
### `sendgrid_delete_contacts`
|
||||
|
||||
Einen oder mehrere Kontakte aus SendGrid löschen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `contactIds` | string | Ja | Kommagetrennte Kontakt-IDs zum Löschen |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobId` | string | Job-ID für die Löschanfrage |
|
||||
|
||||
### `sendgrid_create_list`
|
||||
|
||||
Erstellen einer neuen Kontaktliste in SendGrid
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `name` | string | Ja | Listenname |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Listen-ID |
|
||||
| `name` | string | Listenname |
|
||||
| `contactCount` | number | Anzahl der Kontakte in der Liste |
|
||||
|
||||
### `sendgrid_get_list`
|
||||
|
||||
Eine bestimmte Liste anhand der ID von SendGrid abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `listId` | string | Ja | Listen-ID |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Listen-ID |
|
||||
| `name` | string | Listenname |
|
||||
| `contactCount` | number | Anzahl der Kontakte in der Liste |
|
||||
|
||||
### `sendgrid_list_all_lists`
|
||||
|
||||
Alle Kontaktlisten von SendGrid abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `pageSize` | number | Nein | Anzahl der Listen, die pro Seite zurückgegeben werden sollen (Standard: 100) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `lists` | json | Array von Listen |
|
||||
|
||||
### `sendgrid_delete_list`
|
||||
|
||||
Eine Kontaktliste von SendGrid löschen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `listId` | string | Ja | Listen-ID zum Löschen |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Erfolgsmeldung |
|
||||
|
||||
### `sendgrid_add_contacts_to_list`
|
||||
|
||||
Kontakte hinzufügen oder aktualisieren und einer Liste in SendGrid zuweisen (verwendet PUT /v3/marketing/contacts)
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `listId` | string | Ja | Listen-ID, zu der Kontakte hinzugefügt werden sollen |
|
||||
| `contacts` | json | Ja | JSON-Array von Kontaktobjekten. Jeder Kontakt muss mindestens Folgendes enthalten: E-Mail \(oder phone_number_id/external_id/anonymous_id\). Beispiel: \[\{"email": "user@example.com", "first_name": "John"\}\] |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobId` | string | Job-ID zur Verfolgung des asynchronen Vorgangs |
|
||||
| `message` | string | Statusmeldung |
|
||||
|
||||
### `sendgrid_remove_contacts_from_list`
|
||||
|
||||
Kontakte aus einer bestimmten Liste in SendGrid entfernen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `listId` | string | Ja | Listen-ID |
|
||||
| `contactIds` | string | Ja | Kommagetrennte Kontakt-IDs, die aus der Liste entfernt werden sollen |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobId` | string | Job-ID für die Anfrage |
|
||||
|
||||
### `sendgrid_create_template`
|
||||
|
||||
Eine neue E-Mail-Vorlage in SendGrid erstellen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `name` | string | Ja | Vorlagenname |
|
||||
| `generation` | string | Nein | Vorlagenerstellungstyp \(legacy oder dynamic, standard: dynamic\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Vorlagen-ID |
|
||||
| `name` | string | Vorlagenname |
|
||||
| `generation` | string | Vorlagenerstellung |
|
||||
| `updatedAt` | string | Zeitstempel der letzten Aktualisierung |
|
||||
| `versions` | json | Array von Vorlagenversionen |
|
||||
|
||||
### `sendgrid_get_template`
|
||||
|
||||
Eine bestimmte Vorlage anhand der ID von SendGrid abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `templateId` | string | Ja | Vorlagen-ID |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Vorlagen-ID |
|
||||
| `name` | string | Vorlagenname |
|
||||
| `generation` | string | Vorlagenerstellung |
|
||||
| `updatedAt` | string | Zeitstempel der letzten Aktualisierung |
|
||||
| `versions` | json | Array von Vorlagenversionen |
|
||||
|
||||
### `sendgrid_list_templates`
|
||||
|
||||
Alle E-Mail-Vorlagen von SendGrid abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `generations` | string | Nein | Nach Generation filtern (legacy, dynamic oder beides) |
|
||||
| `pageSize` | number | Nein | Anzahl der Vorlagen pro Seite (Standard: 20) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `templates` | json | Array von Vorlagen |
|
||||
|
||||
### `sendgrid_delete_template`
|
||||
|
||||
Eine E-Mail-Vorlage von SendGrid löschen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `templateId` | string | Ja | Zu löschende Vorlagen-ID |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Erfolgsstatus der Operation |
|
||||
| `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 |
|
||||
| `firstName` | string | Vorname |
|
||||
| `lastName` | string | Nachname |
|
||||
| `contacts` | json | Array von Kontakten |
|
||||
| `contactCount` | number | Anzahl der Kontakte |
|
||||
| `lists` | json | Array von Listen |
|
||||
| `templates` | json | Array von Vorlagen |
|
||||
| `message` | string | Status- oder Erfolgsmeldung |
|
||||
| `name` | string | Ressourcenname |
|
||||
| `generation` | string | Vorlagengeneration |
|
||||
|
||||
### `sendgrid_create_template_version`
|
||||
|
||||
Eine neue Version einer E-Mail-Vorlage in SendGrid erstellen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Ja | SendGrid API-Schlüssel |
|
||||
| `templateId` | string | Ja | Vorlagen-ID |
|
||||
| `name` | string | Ja | Versionsname |
|
||||
| `subject` | string | Ja | E-Mail-Betreffzeile |
|
||||
| `htmlContent` | string | Nein | HTML-Inhalt der Vorlage |
|
||||
| `plainContent` | string | Nein | Nur-Text-Inhalt der Vorlage |
|
||||
| `active` | boolean | Nein | Ob diese Version aktiv ist \(Standard: true\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Versions-ID |
|
||||
| `templateId` | string | Vorlagen-ID |
|
||||
| `name` | string | Versionsname |
|
||||
| `subject` | string | E-Mail-Betreff |
|
||||
| `active` | boolean | Ob diese Version aktiv ist |
|
||||
| `htmlContent` | string | HTML-Inhalt |
|
||||
| `plainContent` | string | Nur-Text-Inhalt |
|
||||
| `updatedAt` | string | Zeitstempel der letzten Aktualisierung |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `sendgrid`
|
||||
444
apps/docs/content/docs/de/tools/shopify.mdx
Normal file
444
apps/docs/content/docs/de/tools/shopify.mdx
Normal file
@@ -0,0 +1,444 @@
|
||||
---
|
||||
title: Shopify
|
||||
description: Verwalte Produkte, Bestellungen, Kunden und Lagerbestand in deinem Shopify-Shop
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="shopify"
|
||||
color="#FFFFFF"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Shopify](https://www.shopify.com/) ist eine führende E-Commerce-Plattform, die entwickelt wurde, um Händlern beim Aufbau, Betrieb und Wachstum ihrer Online-Shops zu helfen. Shopify macht es einfach, jeden Aspekt deines Shops zu verwalten, von Produkten und Lagerbestand bis hin zu Bestellungen und Kunden.
|
||||
|
||||
Mit Shopify in Sim können deine Agenten:
|
||||
|
||||
- **Produkte erstellen und verwalten**: Neue Produkte hinzufügen, Produktdetails aktualisieren und Produkte aus deinem Shop entfernen.
|
||||
- **Bestellungen auflisten und abrufen**: Informationen über Kundenbestellungen erhalten, einschließlich Filterung und Bestellverwaltung.
|
||||
- **Kunden verwalten**: Auf Kundendetails zugreifen und diese aktualisieren oder neue Kunden zu deinem Shop hinzufügen.
|
||||
- **Lagerbestände anpassen**: Produktbestände programmatisch ändern, um deinen Lagerbestand genau zu halten.
|
||||
|
||||
Nutze Sims Shopify-Integration, um gängige Shop-Management-Workflows zu automatisieren – wie Lagerbestandssynchronisierung, Auftragsabwicklung oder Angebotsverwaltung – direkt aus deinen Automatisierungen heraus. Ermögliche deinen Agenten, auf alle deine Shop-Daten zuzugreifen, sie zu aktualisieren und zu organisieren, mit einfachen, programmatischen Tools.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanleitung
|
||||
|
||||
Integriere Shopify in deinen Workflow. Verwalte Produkte, Bestellungen, Kunden und Lagerbestand. Erstelle, lese, aktualisiere und lösche Produkte. Liste und verwalte Bestellungen. Bearbeite Kundendaten und passe Lagerbestände an.
|
||||
|
||||
## Tools
|
||||
|
||||
### `shopify_create_product`
|
||||
|
||||
Erstelle ein neues Produkt in deinem Shopify-Shop
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Deine Shopify-Shop-Domain \(z.B. meinshop.myshopify.com\) |
|
||||
| `title` | string | Ja | Produkttitel |
|
||||
| `descriptionHtml` | string | Nein | Produktbeschreibung \(HTML\) |
|
||||
| `vendor` | string | Nein | Produktanbieter/Marke |
|
||||
| `productType` | string | Nein | Produkttyp/Kategorie |
|
||||
| `tags` | array | Nein | Produkt-Tags |
|
||||
| `status` | string | Nein | Produktstatus \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `product` | object | Das erstellte Produkt |
|
||||
|
||||
### `shopify_get_product`
|
||||
|
||||
Ein einzelnes Produkt anhand der ID aus Ihrem Shopify-Shop abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain \(z.B. mystore.myshopify.com\) |
|
||||
| `productId` | string | Ja | Produkt-ID \(gid://shopify/Product/123456789\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `product` | object | Die Produktdetails |
|
||||
|
||||
### `shopify_list_products`
|
||||
|
||||
Produkte aus Ihrem Shopify-Shop mit optionaler Filterung auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain \(z.B. mystore.myshopify.com\) |
|
||||
| `first` | number | Nein | Anzahl der zurückzugebenden Produkte \(Standard: 50, max: 250\) |
|
||||
| `query` | string | Nein | Suchanfrage zum Filtern von Produkten \(z.B. "title:shirt" oder "vendor:Nike" oder "status:active"\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `products` | array | Liste der Produkte |
|
||||
| `pageInfo` | object | Paginierungsinformationen |
|
||||
|
||||
### `shopify_update_product`
|
||||
|
||||
Ein bestehendes Produkt in Ihrem Shopify-Shop aktualisieren
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain \(z.B. mystore.myshopify.com\) |
|
||||
| `productId` | string | Ja | Zu aktualisierende Produkt-ID \(gid://shopify/Product/123456789\) |
|
||||
| `title` | string | Nein | Neuer Produkttitel |
|
||||
| `descriptionHtml` | string | Nein | Neue Produktbeschreibung \(HTML\) |
|
||||
| `vendor` | string | Nein | Neuer Produktanbieter/Marke |
|
||||
| `productType` | string | Nein | Neuer Produkttyp/Kategorie |
|
||||
| `tags` | array | Nein | Neue Produkt-Tags |
|
||||
| `status` | string | Nein | Neuer Produktstatus \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `product` | object | Das aktualisierte Produkt |
|
||||
|
||||
### `shopify_delete_product`
|
||||
|
||||
Ein Produkt aus Ihrem Shopify-Shop löschen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain \(z.B. mystore.myshopify.com\) |
|
||||
| `productId` | string | Ja | Produkt-ID zum Löschen \(gid://shopify/Product/123456789\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deletedId` | string | Die ID des gelöschten Produkts |
|
||||
|
||||
### `shopify_get_order`
|
||||
|
||||
Eine einzelne Bestellung anhand der ID aus Ihrem Shopify-Shop abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain \(z.B. mystore.myshopify.com\) |
|
||||
| `orderId` | string | Ja | Bestell-ID \(gid://shopify/Order/123456789\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | Die Bestelldetails |
|
||||
|
||||
### `shopify_list_orders`
|
||||
|
||||
Bestellungen aus Ihrem Shopify-Shop mit optionaler Filterung auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain \(z.B. mystore.myshopify.com\) |
|
||||
| `first` | number | Nein | Anzahl der zurückzugebenden Bestellungen \(Standard: 50, max: 250\) |
|
||||
| `status` | string | Nein | Nach Bestellstatus filtern \(open, closed, cancelled, any\) |
|
||||
| `query` | string | Nein | Suchanfrage zum Filtern von Bestellungen \(z.B. "financial_status:paid" oder "fulfillment_status:unfulfilled" oder "email:customer@example.com"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orders` | array | Liste der Bestellungen |
|
||||
| `pageInfo` | object | Paginierungsinformationen |
|
||||
|
||||
### `shopify_update_order`
|
||||
|
||||
Aktualisieren einer bestehenden Bestellung in Ihrem Shopify-Shop (Hinweis, Tags, E-Mail)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain \(z.B. mystore.myshopify.com\) |
|
||||
| `orderId` | string | Ja | Zu aktualisierende Bestell-ID \(gid://shopify/Order/123456789\) |
|
||||
| `note` | string | Nein | Neuer Bestellhinweis |
|
||||
| `tags` | array | Nein | Neue Bestell-Tags |
|
||||
| `email` | string | Nein | Neue Kunden-E-Mail für die Bestellung |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | Die aktualisierte Bestellung |
|
||||
|
||||
### `shopify_cancel_order`
|
||||
|
||||
Stornieren einer Bestellung in Ihrem Shopify-Shop
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain \(z.B. mystore.myshopify.com\) |
|
||||
| `orderId` | string | Ja | Zu stornierende Bestell-ID \(gid://shopify/Order/123456789\) |
|
||||
| `reason` | string | Ja | Stornierungsgrund \(CUSTOMER, DECLINED, FRAUD, INVENTORY, STAFF, OTHER\) |
|
||||
| `notifyCustomer` | boolean | Nein | Ob der Kunde über die Stornierung benachrichtigt werden soll |
|
||||
| `refund` | boolean | Nein | Ob die Bestellung erstattet werden soll |
|
||||
| `restock` | boolean | Nein | Ob der Bestand wieder aufgefüllt werden soll |
|
||||
| `staffNote` | string | Nein | Ein Hinweis zur Stornierung für Mitarbeiter |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | Das Stornierungsergebnis |
|
||||
|
||||
### `shopify_create_customer`
|
||||
|
||||
Einen neuen Kunden in Ihrem Shopify-Shop erstellen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain \(z.B. mystore.myshopify.com\) |
|
||||
| `email` | string | Nein | E-Mail-Adresse des Kunden |
|
||||
| `firstName` | string | Nein | Vorname des Kunden |
|
||||
| `lastName` | string | Nein | Nachname des Kunden |
|
||||
| `phone` | string | Nein | Telefonnummer des Kunden |
|
||||
| `note` | string | Nein | Notiz zum Kunden |
|
||||
| `tags` | array | Nein | Kundentags |
|
||||
| `addresses` | array | Nein | Kundenanschriften |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | Der erstellte Kunde |
|
||||
|
||||
### `shopify_get_customer`
|
||||
|
||||
Einen einzelnen Kunden anhand der ID aus Ihrem Shopify-Shop abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain \(z.B. mystore.myshopify.com\) |
|
||||
| `customerId` | string | Ja | Kunden-ID \(gid://shopify/Customer/123456789\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | Die Kundendetails |
|
||||
|
||||
### `shopify_list_customers`
|
||||
|
||||
Kunden aus deinem Shopify-Shop mit optionaler Filterung auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Deine Shopify-Shop-Domain \(z.B. meinshop.myshopify.com\) |
|
||||
| `first` | number | Nein | Anzahl der zurückzugebenden Kunden \(Standard: 50, max: 250\) |
|
||||
| `query` | string | Nein | Suchanfrage zum Filtern von Kunden \(z.B. "first_name:John" oder "last_name:Smith" oder "email:*@gmail.com" oder "tag:vip"\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customers` | array | Liste der Kunden |
|
||||
| `pageInfo` | object | Paginierungsinformationen |
|
||||
|
||||
### `shopify_update_customer`
|
||||
|
||||
Einen bestehenden Kunden in deinem Shopify-Shop aktualisieren
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Deine Shopify-Shop-Domain \(z.B. meinshop.myshopify.com\) |
|
||||
| `customerId` | string | Ja | Kunden-ID zum Aktualisieren \(gid://shopify/Customer/123456789\) |
|
||||
| `email` | string | Nein | Neue E-Mail-Adresse des Kunden |
|
||||
| `firstName` | string | Nein | Neuer Vorname des Kunden |
|
||||
| `lastName` | string | Nein | Neuer Nachname des Kunden |
|
||||
| `phone` | string | Nein | Neue Telefonnummer des Kunden |
|
||||
| `note` | string | Nein | Neue Notiz über den Kunden |
|
||||
| `tags` | array | Nein | Neue Kunden-Tags |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | Der aktualisierte Kunde |
|
||||
|
||||
### `shopify_delete_customer`
|
||||
|
||||
Einen Kunden aus Ihrem Shopify-Shop löschen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain (z.B. meinshop.myshopify.com) |
|
||||
| `customerId` | string | Ja | Kunden-ID zum Löschen (gid://shopify/Customer/123456789) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deletedId` | string | Die ID des gelöschten Kunden |
|
||||
|
||||
### `shopify_list_inventory_items`
|
||||
|
||||
Bestandsartikel aus Ihrem Shopify-Shop auflisten. Verwenden Sie dies, um Bestandsartikel-IDs anhand der SKU zu finden.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain (z.B. meinshop.myshopify.com) |
|
||||
| `first` | number | Nein | Anzahl der zurückzugebenden Bestandsartikel (Standard: 50, max: 250) |
|
||||
| `query` | string | Nein | Suchanfrage zum Filtern von Bestandsartikeln (z.B. "sku:ABC123") |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `inventoryItems` | array | Liste der Bestandsartikel mit ihren IDs, SKUs und Lagerbeständen |
|
||||
| `pageInfo` | object | Paginierungsinformationen |
|
||||
|
||||
### `shopify_get_inventory_level`
|
||||
|
||||
Bestandsmenge für eine Produktvariante an einem bestimmten Standort abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Shop-Domain (z.B. meinshop.myshopify.com) |
|
||||
| `inventoryItemId` | string | Ja | Bestandsartikel-ID (gid://shopify/InventoryItem/123456789) |
|
||||
| `locationId` | string | Nein | Standort-ID zum Filtern (optional) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `inventoryLevel` | object | Die Details zum Bestandsniveau |
|
||||
|
||||
### `shopify_adjust_inventory`
|
||||
|
||||
Bestandsmenge für eine Produktvariante an einem bestimmten Standort anpassen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Store-Domain (z.B. mystore.myshopify.com) |
|
||||
| `inventoryItemId` | string | Ja | Inventar-Element-ID (gid://shopify/InventoryItem/123456789) |
|
||||
| `locationId` | string | Ja | Standort-ID (gid://shopify/Location/123456789) |
|
||||
| `delta` | number | Ja | Anzahl der Anpassung (positiv für Erhöhung, negativ für Verringerung) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `inventoryLevel` | object | Das Ergebnis der Bestandsanpassung |
|
||||
|
||||
### `shopify_list_locations`
|
||||
|
||||
Listet Bestandsstandorte aus Ihrem Shopify-Store auf. Verwenden Sie dies, um Standort-IDs zu finden, die für Bestandsoperationen benötigt werden.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Store-Domain (z.B. mystore.myshopify.com) |
|
||||
| `first` | number | Nein | Anzahl der zurückzugebenden Standorte (Standard: 50, max: 250) |
|
||||
| `includeInactive` | boolean | Nein | Ob deaktivierte Standorte einbezogen werden sollen (Standard: false) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `locations` | array | Liste der Standorte mit ihren IDs, Namen und Adressen |
|
||||
| `pageInfo` | object | Paginierungsinformationen |
|
||||
|
||||
### `shopify_create_fulfillment`
|
||||
|
||||
Erstelle eine Fulfillment-Anfrage, um Bestellartikel als versendet zu markieren. Erfordert eine Fulfillment-Auftrags-ID (diese findest du in den Bestelldetails).
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Deine Shopify-Store-Domain \(z.B. meinshop.myshopify.com\) |
|
||||
| `fulfillmentOrderId` | string | Ja | Die Fulfillment-Auftrags-ID \(z.B. gid://shopify/FulfillmentOrder/123456789\) |
|
||||
| `trackingNumber` | string | Nein | Sendungsverfolgungsnummer |
|
||||
| `trackingCompany` | string | Nein | Name des Versanddienstleisters \(z.B. UPS, FedEx, USPS, DHL\) |
|
||||
| `trackingUrl` | string | Nein | URL zur Sendungsverfolgung |
|
||||
| `notifyCustomer` | boolean | Nein | Ob eine Versandbestätigungs-E-Mail an den Kunden gesendet werden soll \(Standard: true\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `fulfillment` | object | Das erstellte Fulfillment mit Tracking-Informationen und erfüllten Artikeln |
|
||||
|
||||
### `shopify_list_collections`
|
||||
|
||||
Liste Produktkollektionen aus deinem Shopify-Shop auf. Filtere nach Titel, Typ (benutzerdefiniert/smart) oder Handle.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Deine Shopify-Store-Domain \(z.B. meinshop.myshopify.com\) |
|
||||
| `first` | number | Nein | Anzahl der zurückzugebenden Kollektionen \(Standard: 50, max: 250\) |
|
||||
| `query` | string | Nein | Suchanfrage zum Filtern von Kollektionen \(z.B. "title:Sommer" oder "collection_type:smart"\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `collections` | array | Liste der Kollektionen mit ihren IDs, Titeln und Produktanzahlen |
|
||||
| `pageInfo` | object | Paginierungsinformationen |
|
||||
|
||||
### `shopify_get_collection`
|
||||
|
||||
Rufen Sie eine bestimmte Kollektion anhand ihrer ID ab, einschließlich ihrer Produkte. Verwenden Sie dies, um Produkte innerhalb einer Kollektion abzurufen.
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Ja | Ihre Shopify-Store-Domain \(z.B. mystore.myshopify.com\) |
|
||||
| `collectionId` | string | Ja | Die Kollektions-ID \(z.B. gid://shopify/Collection/123456789\) |
|
||||
| `productsFirst` | number | Nein | Anzahl der Produkte, die aus dieser Kollektion zurückgegeben werden sollen \(Standard: 50, max: 250\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `collection` | object | Die Kollektionsdetails einschließlich ihrer Produkte |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `shopify`
|
||||
73
apps/docs/content/docs/de/tools/smtp.mdx
Normal file
73
apps/docs/content/docs/de/tools/smtp.mdx
Normal file
@@ -0,0 +1,73 @@
|
||||
---
|
||||
title: SMTP
|
||||
description: E-Mails über jeden SMTP-Mailserver versenden
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="smtp"
|
||||
color="#4A5568"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[SMTP (Simple Mail Transfer Protocol)](https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol) ist der grundlegende Standard für die E-Mail-Übertragung im Internet. Durch die Verbindung mit einem SMTP-kompatiblen Server – wie Gmail, Outlook oder der eigenen Mail-Infrastruktur Ihrer Organisation – können Sie E-Mails programmatisch versenden und Ihre ausgehende Kommunikation automatisieren.
|
||||
|
||||
Die SMTP-Integration ermöglicht es Ihnen, den E-Mail-Versand durch direkte Serververbindung vollständig anzupassen und unterstützt sowohl einfache als auch fortgeschrittene E-Mail-Anwendungsfälle. Mit SMTP können Sie jeden Aspekt der Nachrichtenzustellung, des Empfängermanagements und der Inhaltsformatierung kontrollieren, was es ideal für transaktionale Benachrichtigungen, Massenmailings und jeden automatisierten Workflow macht, der eine robuste ausgehende E-Mail-Zustellung erfordert.
|
||||
|
||||
**Zu den wichtigsten Funktionen der SMTP-Integration gehören:**
|
||||
|
||||
- **Universeller E-Mail-Versand:** Senden Sie E-Mails über jeden SMTP-Server durch Konfiguration standardmäßiger Serververbindungsparameter.
|
||||
- **Anpassbare Absender und Empfänger:** Legen Sie Absenderadresse, Anzeigename, Hauptempfänger sowie CC- und BCC-Felder fest.
|
||||
- **Unterstützung für umfangreiche Inhalte:** Senden Sie Nur-Text- oder reich formatierte HTML-E-Mails entsprechend Ihren Anforderungen.
|
||||
- **Anhänge:** Fügen Sie ausgehenden E-Mails mehrere Dateien als Anhänge hinzu.
|
||||
- **Flexible Sicherheit:** Verbinden Sie sich über TLS, SSL oder Standardprotokolle (unverschlüsselt), je nach Unterstützung Ihres SMTP-Anbieters.
|
||||
- **Erweiterte Header:** Setzen Sie Antwort-an-Header und andere erweiterte E-Mail-Optionen, um komplexe Mailflows und Benutzerinteraktionen zu ermöglichen.
|
||||
|
||||
Durch die Integration von SMTP mit Sim können Agenten und Workflows programmatisch E-Mails als Teil jedes automatisierten Prozesses versenden – von Benachrichtigungen und Bestätigungen bis hin zur Automatisierung externer Kommunikation, Berichterstattung und Dokumentenzustellung. Dies bietet einen hochflexiblen, anbieterunabhängigen Ansatz zur Verwaltung von E-Mails direkt innerhalb Ihrer KI-gesteuerten Prozesse.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Gebrauchsanweisung
|
||||
|
||||
Senden Sie E-Mails über jeden SMTP-Server (Gmail, Outlook, benutzerdefinierte Server usw.). Konfigurieren Sie SMTP-Verbindungseinstellungen und senden Sie E-Mails mit voller Kontrolle über Inhalt, Empfänger und Anhänge.
|
||||
|
||||
## Tools
|
||||
|
||||
### `smtp_send_mail`
|
||||
|
||||
E-Mails über SMTP-Server senden
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `smtpHost` | string | Ja | SMTP-Server-Hostname \(z.B. smtp.gmail.com\) |
|
||||
| `smtpPort` | number | Ja | SMTP-Server-Port \(587 für TLS, 465 für SSL\) |
|
||||
| `smtpUsername` | string | Ja | SMTP-Authentifizierungsbenutzername |
|
||||
| `smtpPassword` | string | Ja | SMTP-Authentifizierungspasswort |
|
||||
| `smtpSecure` | string | Ja | Sicherheitsprotokoll \(TLS, SSL oder None\) |
|
||||
| `from` | string | Ja | Absender-E-Mail-Adresse |
|
||||
| `to` | string | Ja | Empfänger-E-Mail-Adresse |
|
||||
| `subject` | string | Ja | E-Mail-Betreff |
|
||||
| `body` | string | Ja | E-Mail-Inhalt |
|
||||
| `contentType` | string | Nein | Inhaltstyp \(text oder html\) |
|
||||
| `fromName` | string | Nein | Anzeigename für Absender |
|
||||
| `cc` | string | Nein | CC-Empfänger \(durch Komma getrennt\) |
|
||||
| `bcc` | string | Nein | BCC-Empfänger \(durch Komma getrennt\) |
|
||||
| `replyTo` | string | Nein | Antwort-an E-Mail-Adresse |
|
||||
| `attachments` | file[] | Nein | Dateien, die der E-Mail angehängt werden sollen |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die E-Mail erfolgreich gesendet wurde |
|
||||
| `messageId` | string | Nachrichten-ID vom SMTP-Server |
|
||||
| `to` | string | Empfänger-E-Mail-Adresse |
|
||||
| `subject` | string | E-Mail-Betreff |
|
||||
| `error` | string | Fehlermeldung, wenn das Senden fehlgeschlagen ist |
|
||||
|
||||
## Notizen
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `smtp`
|
||||
394
apps/docs/content/docs/de/tools/ssh.mdx
Normal file
394
apps/docs/content/docs/de/tools/ssh.mdx
Normal file
@@ -0,0 +1,394 @@
|
||||
---
|
||||
title: SSH
|
||||
description: Verbindung zu Remote-Servern über SSH herstellen
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="ssh"
|
||||
color="#000000"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[SSH (Secure Shell)](https://en.wikipedia.org/wiki/Secure_Shell) ist ein weit verbreitetes Protokoll für die sichere Verbindung zu Remote-Servern, das es ermöglicht, Befehle auszuführen, Dateien zu übertragen und Systeme über verschlüsselte Kanäle zu verwalten.
|
||||
|
||||
Mit SSH-Unterstützung in Sim können Ihre Agenten:
|
||||
|
||||
- **Remote-Befehle ausführen**: Shell-Befehle auf jedem SSH-zugänglichen Server ausführen
|
||||
- **Skripte hochladen und ausführen**: Einfaches Übertragen und Ausführen von mehrzeiligen Skripten für erweiterte Automatisierung
|
||||
- **Dateien sicher übertragen**: Hoch- und Herunterladen von Dateien als Teil Ihrer Workflows (demnächst oder per Befehl)
|
||||
- **Serververwaltung automatisieren**: Programmatische Durchführung von Updates, Wartung, Überwachung, Bereitstellungen und Konfigurationsaufgaben
|
||||
- **Flexible Authentifizierung nutzen**: Verbindung mit Passwort- oder Private-Key-Authentifizierung, einschließlich Unterstützung für verschlüsselte Schlüssel
|
||||
|
||||
Die folgenden Sim SSH-Tools ermöglichen es Ihren Agenten, mit Servern als Teil größerer Automatisierungen zu interagieren:
|
||||
|
||||
- `ssh_execute_command`: Führt einen einzelnen Shell-Befehl remote aus und erfasst Ausgabe, Status und Fehler.
|
||||
- `ssh_execute_script`: Lädt ein vollständiges mehrzeiliges Skript hoch und führt es auf dem Remote-System aus.
|
||||
- (Weitere Tools wie Dateiübertragung kommen in Kürze.)
|
||||
|
||||
Durch die Integration von SSH in Ihre Agenten-Workflows können Sie sicheren Zugriff, Remote-Operationen und Server-Orchestrierung automatisieren – und so DevOps, IT-Automatisierung und benutzerdefinierte Remote-Verwaltung rationalisieren, alles innerhalb von Sim.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanleitung
|
||||
|
||||
Führen Sie Befehle aus, übertragen Sie Dateien und verwalten Sie Remote-Server über SSH. Unterstützt Passwort- und Private-Key-Authentifizierung für sicheren Serverzugriff.
|
||||
|
||||
## Tools
|
||||
|
||||
### `ssh_execute_command`
|
||||
|
||||
Einen Shell-Befehl auf einem Remote-SSH-Server ausführen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port \(Standard: 22\) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung \(wenn kein Private Key verwendet wird\) |
|
||||
| `privateKey` | string | Nein | Private Key für die Authentifizierung \(OpenSSH-Format\) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten Private Key |
|
||||
| `command` | string | Ja | Shell-Befehl, der auf dem Remote-Server ausgeführt werden soll |
|
||||
| `workingDirectory` | string | Nein | Arbeitsverzeichnis für die Befehlsausführung |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `stdout` | string | Standardausgabe des Befehls |
|
||||
| `stderr` | string | Standardfehlerausgabe |
|
||||
| `exitCode` | number | Exit-Code des Befehls |
|
||||
| `success` | boolean | Ob der Befehl erfolgreich war (Exit-Code 0) |
|
||||
| `message` | string | Statusmeldung des Vorgangs |
|
||||
|
||||
### `ssh_execute_script`
|
||||
|
||||
Ein mehrzeiliges Skript auf einem entfernten SSH-Server hochladen und ausführen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port (Standard: 22) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung (falls kein privater Schlüssel verwendet wird) |
|
||||
| `privateKey` | string | Nein | Privater Schlüssel für die Authentifizierung (OpenSSH-Format) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten privaten Schlüssel |
|
||||
| `script` | string | Ja | Skriptinhalt zur Ausführung (bash, python, etc.) |
|
||||
| `interpreter` | string | Nein | Skript-Interpreter (Standard: /bin/bash) |
|
||||
| `workingDirectory` | string | Nein | Arbeitsverzeichnis für die Skriptausführung |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `stdout` | string | Standardausgabe des Skripts |
|
||||
| `stderr` | string | Standardfehlerausgabe |
|
||||
| `exitCode` | number | Exit-Code des Skripts |
|
||||
| `success` | boolean | Ob das Skript erfolgreich war (Exit-Code 0) |
|
||||
| `scriptPath` | string | Temporärer Pfad, wohin das Skript hochgeladen wurde |
|
||||
| `message` | string | Statusmeldung des Vorgangs |
|
||||
|
||||
### `ssh_check_command_exists`
|
||||
|
||||
Überprüfen, ob ein Befehl/Programm auf dem entfernten SSH-Server existiert
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port \(Standard: 22\) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung \(wenn kein privater Schlüssel verwendet wird\) |
|
||||
| `privateKey` | string | Nein | Privater Schlüssel für die Authentifizierung \(OpenSSH-Format\) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten privaten Schlüssel |
|
||||
| `commandName` | string | Ja | Zu überprüfender Befehlsname \(z.B. docker, git, python3\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `commandExists` | boolean | Ob der Befehl existiert |
|
||||
| `commandPath` | string | Vollständiger Pfad zum Befehl \(falls gefunden\) |
|
||||
| `version` | string | Versionsinformation des Befehls \(falls zutreffend\) |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
|
||||
### `ssh_upload_file`
|
||||
|
||||
Eine Datei auf einen entfernten SSH-Server hochladen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port \(Standard: 22\) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung \(wenn kein privater Schlüssel verwendet wird\) |
|
||||
| `privateKey` | string | Nein | Privater Schlüssel für die Authentifizierung \(OpenSSH-Format\) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten privaten Schlüssel |
|
||||
| `fileContent` | string | Ja | Hochzuladender Dateiinhalt \(base64-kodiert für Binärdateien\) |
|
||||
| `fileName` | string | Ja | Name der hochzuladenden Datei |
|
||||
| `remotePath` | string | Ja | Zielpfad auf dem entfernten Server |
|
||||
| `permissions` | string | Nein | Dateiberechtigungen \(z.B. 0644\) |
|
||||
| `overwrite` | boolean | Nein | Ob bestehende Dateien überschrieben werden sollen \(Standard: true\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `uploaded` | boolean | Ob die Datei erfolgreich hochgeladen wurde |
|
||||
| `remotePath` | string | Endgültiger Pfad auf dem Remote-Server |
|
||||
| `size` | number | Dateigröße in Bytes |
|
||||
| `message` | string | Statusmeldung des Vorgangs |
|
||||
|
||||
### `ssh_download_file`
|
||||
|
||||
Eine Datei von einem Remote-SSH-Server herunterladen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port \(Standard: 22\) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung \(wenn kein privater Schlüssel verwendet wird\) |
|
||||
| `privateKey` | string | Nein | Privater Schlüssel für die Authentifizierung \(OpenSSH-Format\) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten privaten Schlüssel |
|
||||
| `remotePath` | string | Ja | Pfad der Datei auf dem Remote-Server |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `downloaded` | boolean | Ob die Datei erfolgreich heruntergeladen wurde |
|
||||
| `fileContent` | string | Dateiinhalt \(base64-kodiert für Binärdateien\) |
|
||||
| `fileName` | string | Name der heruntergeladenen Datei |
|
||||
| `remotePath` | string | Quellpfad auf dem Remote-Server |
|
||||
| `size` | number | Dateigröße in Bytes |
|
||||
| `message` | string | Statusmeldung des Vorgangs |
|
||||
|
||||
### `ssh_list_directory`
|
||||
|
||||
Dateien und Verzeichnisse in einem Remote-Verzeichnis auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port \(Standard: 22\) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung \(wenn kein privater Schlüssel verwendet wird\) |
|
||||
| `privateKey` | string | Nein | Privater Schlüssel für die Authentifizierung \(OpenSSH-Format\) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten privaten Schlüssel |
|
||||
| `path` | string | Ja | Remote-Verzeichnispfad zum Auflisten |
|
||||
| `detailed` | boolean | Nein | Dateidetails einschließen \(Größe, Berechtigungen, Änderungsdatum\) |
|
||||
| `recursive` | boolean | Nein | Unterverzeichnisse rekursiv auflisten \(Standard: false\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `entries` | array | Array von Datei- und Verzeichniseinträgen |
|
||||
|
||||
### `ssh_check_file_exists`
|
||||
|
||||
Überprüfen, ob eine Datei oder ein Verzeichnis auf dem Remote-SSH-Server existiert
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port \(Standard: 22\) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung \(wenn kein privater Schlüssel verwendet wird\) |
|
||||
| `privateKey` | string | Nein | Privater Schlüssel für die Authentifizierung \(OpenSSH-Format\) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten privaten Schlüssel |
|
||||
| `path` | string | Ja | Remote-Datei- oder Verzeichnispfad zur Überprüfung |
|
||||
| `type` | string | Nein | Erwarteter Typ: Datei, Verzeichnis oder beliebig \(Standard: beliebig\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `exists` | boolean | Ob der Pfad existiert |
|
||||
| `type` | string | Typ des Pfads (Datei, Verzeichnis, Symlink, nicht_gefunden) |
|
||||
| `size` | number | Dateigröße, wenn es eine Datei ist |
|
||||
| `permissions` | string | Dateiberechtigungen (z.B. 0755) |
|
||||
| `modified` | string | Zeitstempel der letzten Änderung |
|
||||
| `message` | string | Statusmeldung des Vorgangs |
|
||||
|
||||
### `ssh_create_directory`
|
||||
|
||||
Erstellt ein Verzeichnis auf dem entfernten SSH-Server
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port (Standard: 22) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung (wenn kein privater Schlüssel verwendet wird) |
|
||||
| `privateKey` | string | Nein | Privater Schlüssel für die Authentifizierung (OpenSSH-Format) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten privaten Schlüssel |
|
||||
| `path` | string | Ja | Verzeichnispfad zum Erstellen |
|
||||
| `recursive` | boolean | Nein | Übergeordnete Verzeichnisse erstellen, wenn sie nicht existieren (Standard: true) |
|
||||
| `permissions` | string | Nein | Verzeichnisberechtigungen (Standard: 0755) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `created` | boolean | Ob das Verzeichnis erfolgreich erstellt wurde |
|
||||
| `remotePath` | string | Erstellter Verzeichnispfad |
|
||||
| `alreadyExists` | boolean | Ob das Verzeichnis bereits existierte |
|
||||
| `message` | string | Statusmeldung des Vorgangs |
|
||||
|
||||
### `ssh_delete_file`
|
||||
|
||||
Löschen einer Datei oder eines Verzeichnisses vom entfernten SSH-Server
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port \(Standard: 22\) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung \(wenn kein privater Schlüssel verwendet wird\) |
|
||||
| `privateKey` | string | Nein | Privater Schlüssel für die Authentifizierung \(OpenSSH-Format\) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten privaten Schlüssel |
|
||||
| `path` | string | Ja | Zu löschender Pfad |
|
||||
| `recursive` | boolean | Nein | Verzeichnisse rekursiv löschen \(Standard: false\) |
|
||||
| `force` | boolean | Nein | Löschen ohne Bestätigung erzwingen \(Standard: false\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Ob der Pfad erfolgreich gelöscht wurde |
|
||||
| `remotePath` | string | Gelöschter Pfad |
|
||||
| `message` | string | Statusmeldung des Vorgangs |
|
||||
|
||||
### `ssh_move_rename`
|
||||
|
||||
Verschieben oder umbenennen einer Datei oder eines Verzeichnisses auf dem entfernten SSH-Server
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port \(Standard: 22\) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung \(wenn kein privater Schlüssel verwendet wird\) |
|
||||
| `privateKey` | string | Nein | Privater Schlüssel für die Authentifizierung \(OpenSSH-Format\) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten privaten Schlüssel |
|
||||
| `sourcePath` | string | Ja | Aktueller Pfad der Datei oder des Verzeichnisses |
|
||||
| `destinationPath` | string | Ja | Neuer Pfad für die Datei oder das Verzeichnis |
|
||||
| `overwrite` | boolean | Nein | Ziel überschreiben, falls es existiert \(Standard: false\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `moved` | boolean | Ob der Vorgang erfolgreich war |
|
||||
| `sourcePath` | string | Ursprünglicher Pfad |
|
||||
| `destinationPath` | string | Neuer Pfad |
|
||||
| `message` | string | Statusmeldung des Vorgangs |
|
||||
|
||||
### `ssh_get_system_info`
|
||||
|
||||
Systeminformationen vom entfernten SSH-Server abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port \(Standard: 22\) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung \(wenn kein privater Schlüssel verwendet wird\) |
|
||||
| `privateKey` | string | Nein | Privater Schlüssel für die Authentifizierung \(OpenSSH-Format\) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten privaten Schlüssel |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `hostname` | string | Server-Hostname |
|
||||
| `os` | string | Betriebssystem \(z.B. Linux, Darwin\) |
|
||||
| `architecture` | string | CPU-Architektur \(z.B. x64, arm64\) |
|
||||
| `uptime` | number | Systemlaufzeit in Sekunden |
|
||||
| `memory` | json | Speicherinformationen \(gesamt, frei, verwendet\) |
|
||||
| `diskSpace` | json | Festplattenplatzinformationen \(gesamt, frei, verwendet\) |
|
||||
| `message` | string | Statusmeldung des Vorgangs |
|
||||
|
||||
### `ssh_read_file_content`
|
||||
|
||||
Inhalt einer entfernten Datei lesen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port \(Standard: 22\) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung \(wenn kein privater Schlüssel verwendet wird\) |
|
||||
| `privateKey` | string | Nein | Privater Schlüssel für die Authentifizierung \(OpenSSH-Format\) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten privaten Schlüssel |
|
||||
| `path` | string | Ja | Pfad zur entfernten Datei, die gelesen werden soll |
|
||||
| `encoding` | string | Nein | Dateikodierung \(Standard: utf-8\) |
|
||||
| `maxSize` | number | Nein | Maximale zu lesende Dateigröße in MB \(Standard: 10\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | Dateiinhalt als Zeichenfolge |
|
||||
| `size` | number | Dateigröße in Bytes |
|
||||
| `lines` | number | Anzahl der Zeilen in der Datei |
|
||||
| `remotePath` | string | Pfad zur entfernten Datei |
|
||||
| `message` | string | Statusmeldung des Vorgangs |
|
||||
|
||||
### `ssh_write_file_content`
|
||||
|
||||
Inhalt in eine entfernte Datei schreiben oder anhängen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Ja | SSH-Server-Hostname oder IP-Adresse |
|
||||
| `port` | number | Ja | SSH-Server-Port \(Standard: 22\) |
|
||||
| `username` | string | Ja | SSH-Benutzername |
|
||||
| `password` | string | Nein | Passwort für die Authentifizierung \(wenn kein privater Schlüssel verwendet wird\) |
|
||||
| `privateKey` | string | Nein | Privater Schlüssel für die Authentifizierung \(OpenSSH-Format\) |
|
||||
| `passphrase` | string | Nein | Passphrase für verschlüsselten privaten Schlüssel |
|
||||
| `path` | string | Ja | Pfad zur entfernten Datei, in die geschrieben werden soll |
|
||||
| `content` | string | Ja | Inhalt, der in die Datei geschrieben werden soll |
|
||||
| `mode` | string | Nein | Schreibmodus: überschreiben, anhängen oder erstellen \(Standard: überschreiben\) |
|
||||
| `permissions` | string | Nein | Dateiberechtigungen \(z.B. 0644\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `written` | boolean | Ob die Datei erfolgreich geschrieben wurde |
|
||||
| `remotePath` | string | Dateipfad |
|
||||
| `size` | number | Endgültige Dateigröße in Bytes |
|
||||
| `message` | string | Statusmeldung der Operation |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `ssh`
|
||||
566
apps/docs/content/docs/de/tools/wordpress.mdx
Normal file
566
apps/docs/content/docs/de/tools/wordpress.mdx
Normal file
@@ -0,0 +1,566 @@
|
||||
---
|
||||
title: WordPress
|
||||
description: WordPress-Inhalte verwalten
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="wordpress"
|
||||
color="#21759B"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[WordPress](https://wordpress.org/) ist das weltweit führende Open-Source-Content-Management-System, das es einfach macht, Websites, Blogs und alle Arten von Online-Inhalten zu veröffentlichen und zu verwalten. Mit WordPress können Sie Beiträge oder Seiten erstellen und aktualisieren, Ihre Inhalte mit Kategorien und Schlagwörtern organisieren, Mediendateien verwalten, Kommentare moderieren und Benutzerkonten verwalten – so können Sie alles von persönlichen Blogs bis hin zu komplexen Unternehmenswebsites betreiben.
|
||||
|
||||
Die Integration von Sim mit WordPress ermöglicht es Ihren Agenten, wesentliche Website-Aufgaben zu automatisieren. Sie können programmatisch neue Blogbeiträge mit spezifischen Titeln, Inhalten, Kategorien, Schlagwörtern und Hauptbildern erstellen. Das Aktualisieren bestehender Beiträge – wie das Ändern von Inhalten, Titeln oder Veröffentlichungsstatus – ist unkompliziert. Sie können Inhalte auch veröffentlichen oder als Entwürfe speichern, statische Seiten verwalten, mit Medien-Uploads arbeiten, Kommentare überwachen und Inhalte relevanten Organisationstaxonomien zuweisen.
|
||||
|
||||
Durch die Verbindung von WordPress mit Ihren Automatisierungen ermöglicht Sim Ihren Agenten, die Veröffentlichung von Inhalten, redaktionelle Arbeitsabläufe und die tägliche Website-Verwaltung zu optimieren – so bleibt Ihre Website ohne manuellen Aufwand aktuell, organisiert und sicher.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanleitung
|
||||
|
||||
Integrieren Sie WordPress, um Beiträge, Seiten, Medien, Kommentare, Kategorien, Schlagwörter und Benutzer zu erstellen, zu aktualisieren und zu verwalten. Unterstützt WordPress.com-Websites über OAuth und selbst gehostete WordPress-Websites mit Anwendungspasswort-Authentifizierung.
|
||||
|
||||
## Tools
|
||||
|
||||
### `wordpress_create_post`
|
||||
|
||||
Einen neuen Blogbeitrag in WordPress.com erstellen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder meineseite.wordpress.com\) |
|
||||
| `title` | string | Ja | Beitragstitel |
|
||||
| `content` | string | Nein | Beitragsinhalt \(HTML oder Klartext\) |
|
||||
| `status` | string | Nein | Beitragsstatus: publish, draft, pending, private oder future |
|
||||
| `excerpt` | string | Nein | Beitragsauszug |
|
||||
| `categories` | string | Nein | Kommagetrennte Kategorie-IDs |
|
||||
| `tags` | string | Nein | Kommagetrennte Schlagwort-IDs |
|
||||
| `featuredMedia` | number | Nein | Medien-ID des Hauptbildes |
|
||||
| `slug` | string | Nein | URL-Slug für den Beitrag |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `post` | object | Der erstellte Beitrag |
|
||||
|
||||
### `wordpress_update_post`
|
||||
|
||||
Aktualisieren eines vorhandenen Blog-Beitrags in WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `postId` | number | Ja | Die ID des zu aktualisierenden Beitrags |
|
||||
| `title` | string | Nein | Beitragstitel |
|
||||
| `content` | string | Nein | Beitragsinhalt \(HTML oder Klartext\) |
|
||||
| `status` | string | Nein | Beitragsstatus: publish, draft, pending, private oder future |
|
||||
| `excerpt` | string | Nein | Beitragsauszug |
|
||||
| `categories` | string | Nein | Kommagetrennte Kategorie-IDs |
|
||||
| `tags` | string | Nein | Kommagetrennte Tag-IDs |
|
||||
| `featuredMedia` | number | Nein | Medien-ID des Beitragsbilds |
|
||||
| `slug` | string | Nein | URL-Slug für den Beitrag |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `post` | object | Der aktualisierte Beitrag |
|
||||
|
||||
### `wordpress_delete_post`
|
||||
|
||||
Löschen eines Blog-Beitrags von WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `postId` | number | Ja | Die ID des zu löschenden Beitrags |
|
||||
| `force` | boolean | Nein | Papierkorb umgehen und dauerhaft löschen erzwingen |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Gibt an, ob der Beitrag gelöscht wurde |
|
||||
| `post` | object | Der gelöschte Beitrag |
|
||||
|
||||
### `wordpress_get_post`
|
||||
|
||||
Einen einzelnen Blog-Beitrag von WordPress.com anhand der ID abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `postId` | number | Ja | Die ID des abzurufenden Beitrags |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `post` | object | Der abgerufene Beitrag |
|
||||
|
||||
### `wordpress_list_posts`
|
||||
|
||||
Blog-Beiträge von WordPress.com mit optionalen Filtern auflisten
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `perPage` | number | Nein | Anzahl der Beiträge pro Seite \(Standard: 10, max: 100\) |
|
||||
| `page` | number | Nein | Seitennummer für Paginierung |
|
||||
| `status` | string | Nein | Beitragsstatus-Filter: publish, draft, pending, private |
|
||||
| `author` | number | Nein | Nach Autor-ID filtern |
|
||||
| `categories` | string | Nein | Kommagetrennte Kategorie-IDs zum Filtern |
|
||||
| `tags` | string | Nein | Kommagetrennte Tag-IDs zum Filtern |
|
||||
| `search` | string | Nein | Suchbegriff zum Filtern von Beiträgen |
|
||||
| `orderBy` | string | Nein | Sortieren nach Feld: date, id, title, slug, modified |
|
||||
| `order` | string | Nein | Sortierrichtung: asc oder desc |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `posts` | array | Liste der Beiträge |
|
||||
|
||||
### `wordpress_create_page`
|
||||
|
||||
Eine neue Seite in WordPress.com erstellen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder meinseite.wordpress.com\) |
|
||||
| `title` | string | Ja | Seitentitel |
|
||||
| `content` | string | Nein | Seiteninhalt \(HTML oder Klartext\) |
|
||||
| `status` | string | Nein | Seitenstatus: publish, draft, pending, private |
|
||||
| `excerpt` | string | Nein | Seitenauszug |
|
||||
| `parent` | number | Nein | Übergeordnete Seiten-ID für hierarchische Seiten |
|
||||
| `menuOrder` | number | Nein | Reihenfolge im Seitenmenü |
|
||||
| `featuredMedia` | number | Nein | Medien-ID des Beitragsbilds |
|
||||
| `slug` | string | Nein | URL-Slug für die Seite |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `page` | object | Die erstellte Seite |
|
||||
|
||||
### `wordpress_update_page`
|
||||
|
||||
Eine bestehende Seite in WordPress.com aktualisieren
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder meinseite.wordpress.com\) |
|
||||
| `pageId` | number | Ja | Die ID der zu aktualisierenden Seite |
|
||||
| `title` | string | Nein | Seitentitel |
|
||||
| `content` | string | Nein | Seiteninhalt \(HTML oder Klartext\) |
|
||||
| `status` | string | Nein | Seitenstatus: publish, draft, pending, private |
|
||||
| `excerpt` | string | Nein | Seitenauszug |
|
||||
| `parent` | number | Nein | Übergeordnete Seiten-ID für hierarchische Seiten |
|
||||
| `menuOrder` | number | Nein | Reihenfolge im Seitenmenü |
|
||||
| `featuredMedia` | number | Nein | Medien-ID des Beitragsbilds |
|
||||
| `slug` | string | Nein | URL-Slug für die Seite |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `page` | object | Die aktualisierte Seite |
|
||||
|
||||
### `wordpress_delete_page`
|
||||
|
||||
Eine Seite von WordPress.com löschen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `pageId` | number | Ja | Die ID der zu löschenden Seite |
|
||||
| `force` | boolean | Nein | Papierkorb umgehen und dauerhaft löschen erzwingen |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Ob die Seite gelöscht wurde |
|
||||
| `page` | object | Die gelöschte Seite |
|
||||
|
||||
### `wordpress_get_page`
|
||||
|
||||
Eine einzelne Seite von WordPress.com anhand der ID abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `pageId` | number | Ja | Die ID der abzurufenden Seite |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `page` | object | Die abgerufene Seite |
|
||||
|
||||
### `wordpress_list_pages`
|
||||
|
||||
Seiten von WordPress.com mit optionalen Filtern auflisten
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `perPage` | number | Nein | Anzahl der Seiten pro Anfrage \(Standard: 10, max: 100\) |
|
||||
| `page` | number | Nein | Seitennummer für Paginierung |
|
||||
| `status` | string | Nein | Seitenstatus-Filter: publish, draft, pending, private |
|
||||
| `parent` | number | Nein | Nach übergeordneter Seiten-ID filtern |
|
||||
| `search` | string | Nein | Suchbegriff zum Filtern von Seiten |
|
||||
| `orderBy` | string | Nein | Sortieren nach Feld: date, id, title, slug, modified, menu_order |
|
||||
| `order` | string | Nein | Sortierrichtung: asc oder desc |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pages` | array | Liste der Seiten |
|
||||
|
||||
### `wordpress_upload_media`
|
||||
|
||||
Eine Mediendatei (Bild, Video, Dokument) zu WordPress.com hochladen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `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 |
|
||||
| `description` | string | Nein | Medienbeschreibung |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `media` | object | Das hochgeladene Medienelement |
|
||||
|
||||
### `wordpress_get_media`
|
||||
|
||||
Ein einzelnes Medienelement von WordPress.com anhand der ID abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Website-ID oder Domain \(z.B. 12345678 oder meinwebsite.wordpress.com\) |
|
||||
| `mediaId` | number | Ja | Die ID des abzurufenden Medienelements |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `media` | object | Das abgerufene Medienelement |
|
||||
|
||||
### `wordpress_list_media`
|
||||
|
||||
Medienelemente aus der WordPress.com-Medienbibliothek auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `perPage` | number | Nein | Anzahl der Medienelemente pro Anfrage \(Standard: 10, max: 100\) |
|
||||
| `page` | number | Nein | Seitenzahl für Paginierung |
|
||||
| `search` | string | Nein | Suchbegriff zum Filtern von Medien |
|
||||
| `mediaType` | string | Nein | Nach Medientyp filtern: image, video, audio, application |
|
||||
| `mimeType` | string | Nein | Nach spezifischem MIME-Typ filtern \(z.B. image/jpeg\) |
|
||||
| `orderBy` | string | Nein | Sortieren nach Feld: date, id, title, slug |
|
||||
| `order` | string | Nein | Sortierrichtung: asc oder desc |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `media` | array | Liste der Medienelemente |
|
||||
|
||||
### `wordpress_delete_media`
|
||||
|
||||
Ein Medienelement von WordPress.com löschen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `mediaId` | number | Ja | Die ID des zu löschenden Medienelements |
|
||||
| `force` | boolean | Nein | Erzwungenes Löschen \(Medien haben keinen Papierkorb, daher ist das Löschen permanent\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Ob das Medium gelöscht wurde |
|
||||
| `media` | object | Das gelöschte Medienelement |
|
||||
|
||||
### `wordpress_create_comment`
|
||||
|
||||
Einen neuen Kommentar zu einem WordPress.com-Beitrag erstellen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `postId` | number | Ja | Die ID des Beitrags, der kommentiert werden soll |
|
||||
| `content` | string | Ja | Kommentarinhalt |
|
||||
| `parent` | number | Nein | Übergeordnete Kommentar-ID für Antworten |
|
||||
| `authorName` | string | Nein | Anzeigename des Kommentarautors |
|
||||
| `authorEmail` | string | Nein | E-Mail des Kommentarautors |
|
||||
| `authorUrl` | string | Nein | URL des Kommentarautors |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `comment` | object | Der erstellte Kommentar |
|
||||
|
||||
### `wordpress_list_comments`
|
||||
|
||||
Kommentare von WordPress.com mit optionalen Filtern auflisten
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `perPage` | number | Nein | Anzahl der Kommentare pro Anfrage \(Standard: 10, max: 100\) |
|
||||
| `page` | number | Nein | Seitenzahl für Paginierung |
|
||||
| `postId` | number | Nein | Nach Beitrags-ID filtern |
|
||||
| `status` | string | Nein | Nach Kommentarstatus filtern: approved, hold, spam, trash |
|
||||
| `search` | string | Nein | Suchbegriff zum Filtern von Kommentaren |
|
||||
| `orderBy` | string | Nein | Sortieren nach Feld: date, id, parent |
|
||||
| `order` | string | Nein | Sortierrichtung: asc oder desc |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `comments` | array | Liste der Kommentare |
|
||||
|
||||
### `wordpress_update_comment`
|
||||
|
||||
Aktualisieren eines Kommentars in WordPress.com (Inhalt oder Status)
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `commentId` | number | Ja | Die ID des zu aktualisierenden Kommentars |
|
||||
| `content` | string | Nein | Aktualisierter Kommentarinhalt |
|
||||
| `status` | string | Nein | Kommentarstatus: approved, hold, spam, trash |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `comment` | object | Der aktualisierte Kommentar |
|
||||
|
||||
### `wordpress_delete_comment`
|
||||
|
||||
Löschen eines Kommentars von WordPress.com
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `commentId` | number | Ja | Die ID des zu löschenden Kommentars |
|
||||
| `force` | boolean | Nein | Papierkorb umgehen und dauerhaft löschen erzwingen |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Ob der Kommentar gelöscht wurde |
|
||||
| `comment` | object | Der gelöschte Kommentar |
|
||||
|
||||
### `wordpress_create_category`
|
||||
|
||||
Erstellen einer neuen Kategorie in WordPress.com
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder meinseite.wordpress.com\) |
|
||||
| `name` | string | Ja | Kategoriename |
|
||||
| `description` | string | Nein | Kategoriebeschreibung |
|
||||
| `parent` | number | Nein | Übergeordnete Kategorie-ID für hierarchische Kategorien |
|
||||
| `slug` | string | Nein | URL-Slug für die Kategorie |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `category` | object | Die erstellte Kategorie |
|
||||
|
||||
### `wordpress_list_categories`
|
||||
|
||||
Kategorien von WordPress.com auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder meinseite.wordpress.com\) |
|
||||
| `perPage` | number | Nein | Anzahl der Kategorien pro Anfrage \(Standard: 10, max: 100\) |
|
||||
| `page` | number | Nein | Seitenzahl für Paginierung |
|
||||
| `search` | string | Nein | Suchbegriff zum Filtern von Kategorien |
|
||||
| `order` | string | Nein | Sortierrichtung: asc oder desc |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `categories` | array | Liste der Kategorien |
|
||||
|
||||
### `wordpress_create_tag`
|
||||
|
||||
Einen neuen Tag in WordPress.com erstellen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder meinseite.wordpress.com\) |
|
||||
| `name` | string | Ja | Tag-Name |
|
||||
| `description` | string | Nein | Tag-Beschreibung |
|
||||
| `slug` | string | Nein | URL-Slug für den Tag |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tag` | object | Der erstellte Tag |
|
||||
|
||||
### `wordpress_list_tags`
|
||||
|
||||
Tags von WordPress.com auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `perPage` | number | Nein | Anzahl der Tags pro Anfrage \(Standard: 10, max: 100\) |
|
||||
| `page` | number | Nein | Seitennummer für Paginierung |
|
||||
| `search` | string | Nein | Suchbegriff zum Filtern von Tags |
|
||||
| `order` | string | Nein | Sortierrichtung: asc oder desc |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tags` | array | Liste der Tags |
|
||||
|
||||
### `wordpress_get_current_user`
|
||||
|
||||
Informationen über den aktuell authentifizierten WordPress.com-Benutzer abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Der aktuelle Benutzer |
|
||||
|
||||
### `wordpress_list_users`
|
||||
|
||||
Benutzer von WordPress.com auflisten (erfordert Administratorrechte)
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `perPage` | number | Nein | Anzahl der Benutzer pro Anfrage \(Standard: 10, max: 100\) |
|
||||
| `page` | number | Nein | Seitennummer für Paginierung |
|
||||
| `search` | string | Nein | Suchbegriff zum Filtern von Benutzern |
|
||||
| `roles` | string | Nein | Kommagetrennte Rollennamen zum Filtern |
|
||||
| `order` | string | Nein | Sortierrichtung: asc oder desc |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Liste der Benutzer |
|
||||
|
||||
### `wordpress_get_user`
|
||||
|
||||
Einen bestimmten Benutzer von WordPress.com anhand der ID abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `userId` | number | Ja | Die ID des abzurufenden Benutzers |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Der abgerufene Benutzer |
|
||||
|
||||
### `wordpress_search_content`
|
||||
|
||||
Suche über alle Inhaltstypen in WordPress.com (Beiträge, Seiten, Medien)
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Ja | WordPress.com-Site-ID oder Domain \(z.B. 12345678 oder mysite.wordpress.com\) |
|
||||
| `query` | string | Ja | Suchanfrage |
|
||||
| `perPage` | number | Nein | Anzahl der Ergebnisse pro Anfrage \(Standard: 10, max: 100\) |
|
||||
| `page` | number | Nein | Seitenzahl für Paginierung |
|
||||
| `type` | string | Nein | Nach Inhaltstyp filtern: post, page, attachment |
|
||||
| `subtype` | string | Nein | Nach Beitragstyp-Slug filtern \(z.B. post, page\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Suchergebnisse |
|
||||
|
||||
## Notizen
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `wordpress`
|
||||
@@ -109,11 +109,14 @@ Ein neues Ticket in Zendesk erstellen mit Unterstützung für benutzerdefinierte
|
||||
| `subdomain` | string | Ja | Ihre Zendesk-Subdomain |
|
||||
| `subject` | string | Nein | Ticket-Betreff \(optional - wird automatisch generiert, wenn nicht angegeben\) |
|
||||
| `description` | string | Ja | Ticket-Beschreibung \(erster Kommentar\) |
|
||||
| `priority` | string | Nein | Priorität \(niedrig, normal, hoch, dringend\) |
|
||||
| `status` | string | Nein | Status \(neu, offen, ausstehend, angehalten, gelöst, geschlossen\) |
|
||||
| `type` | string | Nein | Typ \(problem, vorfall, frage, aufgabe\) |
|
||||
| `priority` | string | Nein | Priorität \(low, normal, high, urgent\) |
|
||||
| `status` | string | Nein | Status \(new, open, pending, hold, solved, closed\) |
|
||||
| `type` | string | Nein | Typ \(problem, incident, question, task\) |
|
||||
| `tags` | string | Nein | Kommagetrennte Tags |
|
||||
| `assigneeId` | string | Nein | Bearbeiter-Benutzer-ID |
|
||||
| `groupId` | string | Nein | Gruppen-ID |
|
||||
| `requesterId` | string | Nein | Anforderer-Benutzer-ID |
|
||||
| `customFields` | string | Nein | Benutzerdefinierte Felder als JSON-Objekt \(z.B. \{"field_id": "value"\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
250
apps/docs/content/docs/de/tools/zoom.mdx
Normal file
250
apps/docs/content/docs/de/tools/zoom.mdx
Normal file
@@ -0,0 +1,250 @@
|
||||
---
|
||||
title: Zoom
|
||||
description: Zoom-Meetings und -Aufzeichnungen erstellen und verwalten
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="zoom"
|
||||
color="#2D8CFF"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Zoom](https://zoom.us/) ist eine führende cloudbasierte Kommunikationsplattform für Videomeetings, Webinare und Online-Zusammenarbeit. Sie ermöglicht Benutzern und Organisationen, Meetings einfach zu planen, zu hosten und zu verwalten und bietet Tools für Bildschirmfreigabe, Chat, Aufzeichnungen und mehr.
|
||||
|
||||
Mit Zoom können Sie:
|
||||
|
||||
- **Meetings planen und verwalten**: Sofortige oder geplante Meetings erstellen, einschließlich wiederkehrender Termine
|
||||
- **Meeting-Optionen konfigurieren**: Meeting-Passwörter festlegen, Warteräume aktivieren und Video/Audio der Teilnehmer steuern
|
||||
- **Einladungen versenden und Details teilen**: Meeting-Einladungen und Informationen zum einfachen Teilen abrufen
|
||||
- **Meeting-Daten abrufen und aktualisieren**: Auf Meeting-Details zugreifen, bestehende Meetings ändern und Einstellungen programmgesteuert verwalten
|
||||
|
||||
In Sim ermöglicht die Zoom-Integration Ihren Agenten die Automatisierung der Planung und Meeting-Verwaltung. Verwenden Sie Tool-Aktionen, um:
|
||||
|
||||
- Neue Meetings mit benutzerdefinierten Einstellungen programmgesteuert zu erstellen
|
||||
- Alle Meetings für einen bestimmten Benutzer (oder sich selbst) aufzulisten
|
||||
- Details oder Einladungen für jedes Meeting abzurufen
|
||||
- Bestehende Meetings direkt aus Ihren Automatisierungen zu aktualisieren oder zu löschen
|
||||
|
||||
Diese Funktionen ermöglichen es Ihnen, die Remote-Zusammenarbeit zu optimieren, wiederkehrende Videositzungen zu automatisieren und die Zoom-Umgebung Ihrer Organisation als Teil Ihrer Workflows zu verwalten.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Nutzungsanleitung
|
||||
|
||||
Integrieren Sie Zoom in Workflows. Erstellen, listen, aktualisieren und löschen Sie Zoom-Meetings. Rufen Sie Meeting-Details, Einladungen, Aufzeichnungen und Teilnehmer ab. Verwalten Sie Cloud-Aufzeichnungen programmgesteuert.
|
||||
|
||||
## Tools
|
||||
|
||||
### `zoom_create_meeting`
|
||||
|
||||
Ein neues Zoom-Meeting erstellen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `userId` | string | Ja | Die Benutzer-ID oder E-Mail-Adresse. Verwenden Sie "me" für den authentifizierten Benutzer. |
|
||||
| `topic` | string | Ja | Meeting-Thema |
|
||||
| `type` | number | Nein | Meeting-Typ: 1=sofort, 2=geplant, 3=wiederkehrend ohne feste Zeit, 8=wiederkehrend mit fester Zeit |
|
||||
| `startTime` | string | Nein | Meeting-Startzeit im ISO 8601-Format \(z.B. 2025-06-03T10:00:00Z\) |
|
||||
| `duration` | number | Nein | Meeting-Dauer in Minuten |
|
||||
| `timezone` | string | Nein | Zeitzone für das Meeting \(z.B. Europe/Berlin\) |
|
||||
| `password` | string | Nein | Meeting-Passwort |
|
||||
| `agenda` | string | Nein | Meeting-Agenda |
|
||||
| `hostVideo` | boolean | Nein | Mit eingeschaltetem Host-Video starten |
|
||||
| `participantVideo` | boolean | Nein | Mit eingeschaltetem Teilnehmer-Video starten |
|
||||
| `joinBeforeHost` | boolean | Nein | Teilnehmern erlauben, vor dem Host beizutreten |
|
||||
| `muteUponEntry` | boolean | Nein | Teilnehmer beim Betreten stummschalten |
|
||||
| `waitingRoom` | boolean | Nein | Warteraum aktivieren |
|
||||
| `autoRecording` | string | Nein | Automatische Aufzeichnungseinstellung: local, cloud oder none |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `meeting` | object | Das erstellte Meeting mit allen seinen Eigenschaften |
|
||||
|
||||
### `zoom_list_meetings`
|
||||
|
||||
Alle Meetings eines Zoom-Benutzers auflisten
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `userId` | string | Ja | Die Benutzer-ID oder E-Mail-Adresse. Verwenden Sie "me" für den authentifizierten Benutzer. |
|
||||
| `type` | string | Nein | Meeting-Typ-Filter: scheduled, live, upcoming, upcoming_meetings oder previous_meetings |
|
||||
| `pageSize` | number | Nein | Anzahl der Datensätze pro Seite (max. 300) |
|
||||
| `nextPageToken` | string | Nein | Token für Paginierung, um die nächste Ergebnisseite zu erhalten |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `meetings` | array | Liste der Meetings |
|
||||
| `pageInfo` | object | Paginierungsinformationen |
|
||||
|
||||
### `zoom_get_meeting`
|
||||
|
||||
Details eines bestimmten Zoom-Meetings abrufen
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Ja | Die Meeting-ID |
|
||||
| `occurrenceId` | string | Nein | Vorkommnis-ID für wiederkehrende Meetings |
|
||||
| `showPreviousOccurrences` | boolean | Nein | Frühere Vorkommnisse für wiederkehrende Meetings anzeigen |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `meeting` | object | Die Meeting-Details |
|
||||
|
||||
### `zoom_update_meeting`
|
||||
|
||||
Ein bestehendes Zoom-Meeting aktualisieren
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Ja | Die zu aktualisierende Meeting-ID |
|
||||
| `topic` | string | Nein | Meeting-Thema |
|
||||
| `type` | number | Nein | Meeting-Typ: 1=sofort, 2=geplant, 3=wiederkehrend ohne feste Zeit, 8=wiederkehrend mit fester Zeit |
|
||||
| `startTime` | string | Nein | Meeting-Startzeit im ISO 8601-Format \(z.B. 2025-06-03T10:00:00Z\) |
|
||||
| `duration` | number | Nein | Meeting-Dauer in Minuten |
|
||||
| `timezone` | string | Nein | Zeitzone für das Meeting \(z.B. America/Los_Angeles\) |
|
||||
| `password` | string | Nein | Meeting-Passwort |
|
||||
| `agenda` | string | Nein | Meeting-Agenda |
|
||||
| `hostVideo` | boolean | Nein | Mit eingeschalteter Host-Kamera starten |
|
||||
| `participantVideo` | boolean | Nein | Mit eingeschalteter Teilnehmer-Kamera starten |
|
||||
| `joinBeforeHost` | boolean | Nein | Teilnehmern erlauben, vor dem Host beizutreten |
|
||||
| `muteUponEntry` | boolean | Nein | Teilnehmer beim Betreten stummschalten |
|
||||
| `waitingRoom` | boolean | Nein | Warteraum aktivieren |
|
||||
| `autoRecording` | string | Nein | Automatische Aufzeichnungseinstellung: local, cloud oder none |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob das Meeting erfolgreich aktualisiert wurde |
|
||||
|
||||
### `zoom_delete_meeting`
|
||||
|
||||
Ein Zoom-Meeting löschen oder abbrechen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Ja | Die zu löschende Meeting-ID |
|
||||
| `occurrenceId` | string | Nein | Vorkommnis-ID zum Löschen eines bestimmten Vorkommnisses eines wiederkehrenden Meetings |
|
||||
| `scheduleForReminder` | boolean | Nein | Erinnerungs-E-Mail zur Stornierung an Teilnehmer senden |
|
||||
| `cancelMeetingReminder` | boolean | Nein | Stornierungsmail an Teilnehmer und alternative Hosts senden |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob das Meeting erfolgreich gelöscht wurde |
|
||||
|
||||
### `zoom_get_meeting_invitation`
|
||||
|
||||
Abrufen des Einladungstextes für ein Zoom-Meeting
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Ja | Die Meeting-ID |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `invitation` | string | Der Einladungstext für das Meeting |
|
||||
|
||||
### `zoom_list_recordings`
|
||||
|
||||
Alle Cloud-Aufzeichnungen für einen Zoom-Benutzer auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `userId` | string | Ja | Die Benutzer-ID oder E-Mail-Adresse. Verwenden Sie "me" für den authentifizierten Benutzer. |
|
||||
| `from` | string | Nein | Startdatum im Format jjjj-mm-tt \(innerhalb der letzten 6 Monate\) |
|
||||
| `to` | string | Nein | Enddatum im Format jjjj-mm-tt |
|
||||
| `pageSize` | number | Nein | Anzahl der Datensätze pro Seite \(max. 300\) |
|
||||
| `nextPageToken` | string | Nein | Token für die Paginierung, um die nächste Ergebnisseite zu erhalten |
|
||||
| `trash` | boolean | Nein | Auf true setzen, um Aufzeichnungen aus dem Papierkorb aufzulisten |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `recordings` | array | Liste der Aufzeichnungen |
|
||||
| `pageInfo` | object | Paginierungsinformationen |
|
||||
|
||||
### `zoom_get_meeting_recordings`
|
||||
|
||||
Alle Aufzeichnungen für ein bestimmtes Zoom-Meeting abrufen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Ja | Die Meeting-ID oder Meeting-UUID |
|
||||
| `includeFolderItems` | boolean | Nein | Elemente innerhalb eines Ordners einschließen |
|
||||
| `ttl` | number | Nein | Gültigkeitsdauer für Download-URLs in Sekunden \(max 604800\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `recording` | object | Die Meeting-Aufzeichnung mit allen Dateien |
|
||||
|
||||
### `zoom_delete_recording`
|
||||
|
||||
Cloud-Aufzeichnungen für ein Zoom-Meeting löschen
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Ja | Die Meeting-ID oder Meeting-UUID |
|
||||
| `recordingId` | string | Nein | Spezifische Aufzeichnungsdatei-ID zum Löschen. Wenn nicht angegeben, werden alle Aufzeichnungen gelöscht. |
|
||||
| `action` | string | Nein | Löschaktion: "trash" \(in Papierkorb verschieben\) oder "delete" \(dauerhaft löschen\) |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Ob die Aufzeichnung erfolgreich gelöscht wurde |
|
||||
|
||||
### `zoom_list_past_participants`
|
||||
|
||||
Teilnehmer eines vergangenen Zoom-Meetings auflisten
|
||||
|
||||
#### Eingabe
|
||||
|
||||
| Parameter | Typ | Erforderlich | Beschreibung |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Ja | Die vergangene Meeting-ID oder UUID |
|
||||
| `pageSize` | number | Nein | Anzahl der Datensätze pro Seite \(max 300\) |
|
||||
| `nextPageToken` | string | Nein | Token für Paginierung, um die nächste Ergebnisseite zu erhalten |
|
||||
|
||||
#### Ausgabe
|
||||
|
||||
| Parameter | Typ | Beschreibung |
|
||||
| --------- | ---- | ----------- |
|
||||
| `participants` | array | Liste der Besprechungsteilnehmer |
|
||||
| `pageInfo` | object | Paginierungsinformationen |
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Kategorie: `tools`
|
||||
- Typ: `zoom`
|
||||
@@ -66,16 +66,16 @@ Um Umgebungsvariablen in Ihren Workflows zu referenzieren, verwenden Sie die `{{
|
||||
height={350}
|
||||
/>
|
||||
|
||||
## Variablen-Präzedenz
|
||||
## Wie Variablen aufgelöst werden
|
||||
|
||||
Wenn Sie sowohl persönliche als auch Workspace-Variablen mit demselben Namen haben:
|
||||
**Workspace-Variablen haben immer Vorrang** vor persönlichen Variablen, unabhängig davon, wer den Workflow ausführt.
|
||||
|
||||
1. **Workspace-Variablen haben Vorrang** vor persönlichen Variablen
|
||||
2. Dies verhindert Namenskonflikte und gewährleistet ein konsistentes Verhalten in Team-Workflows
|
||||
3. Wenn eine Workspace-Variable existiert, wird die persönliche Variable mit demselben Namen ignoriert
|
||||
Wenn keine Workspace-Variable für einen Schlüssel existiert, werden persönliche Variablen verwendet:
|
||||
- **Manuelle Ausführungen (UI)**: Ihre persönlichen Variablen
|
||||
- **Automatisierte Ausführungen (API, Webhook, Zeitplan, bereitgestellter Chat)**: Persönliche Variablen des Workflow-Besitzers
|
||||
|
||||
<Callout type="warning">
|
||||
Wählen Sie Variablennamen sorgfältig, um unbeabsichtigte Überschreibungen zu vermeiden. Erwägen Sie, persönliche Variablen mit Ihren Initialen oder Workspace-Variablen mit dem Projektnamen zu versehen.
|
||||
<Callout type="info">
|
||||
Persönliche Variablen eignen sich am besten zum Testen. Verwenden Sie Workspace-Variablen für Produktions-Workflows.
|
||||
</Callout>
|
||||
|
||||
## Sicherheits-Best-Practices
|
||||
|
||||
@@ -240,32 +240,78 @@ Retrieve execution details including the workflow state snapshot.
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Webhook Subscriptions
|
||||
## Notifications
|
||||
|
||||
Get real-time notifications when workflow executions complete. Webhooks are configured through the Sim UI in the workflow editor.
|
||||
Get real-time notifications when workflow executions complete via webhook, email, or Slack. Notifications are configured at the workspace level from the Logs page.
|
||||
|
||||
### Configuration
|
||||
|
||||
Webhooks can be configured for each workflow through the workflow editor UI. Click the webhook icon in the control bar to set up your webhook subscriptions.
|
||||
Configure notifications from the Logs page by clicking the menu button and selecting "Configure Notifications".
|
||||
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<Video src="configure-webhook.mp4" width={700} height={450} />
|
||||
</div>
|
||||
**Notification Channels:**
|
||||
- **Webhook**: Send HTTP POST requests to your endpoint
|
||||
- **Email**: Receive email notifications with execution details
|
||||
- **Slack**: Post messages to a Slack channel
|
||||
|
||||
**Available Configuration Options:**
|
||||
**Workflow Selection:**
|
||||
- Select specific workflows to monitor
|
||||
- Or choose "All Workflows" to include current and future workflows
|
||||
|
||||
**Filtering Options:**
|
||||
- `levelFilter`: Log levels to receive (`info`, `error`)
|
||||
- `triggerFilter`: Trigger types to receive (`api`, `webhook`, `schedule`, `manual`, `chat`)
|
||||
|
||||
**Optional Data:**
|
||||
- `includeFinalOutput`: Include the workflow's final output
|
||||
- `includeTraceSpans`: Include detailed execution trace spans
|
||||
- `includeRateLimits`: Include rate limit information (sync/async limits and remaining)
|
||||
- `includeUsageData`: Include billing period usage and limits
|
||||
|
||||
### Alert Rules
|
||||
|
||||
Instead of receiving notifications for every execution, configure alert rules to be notified only when issues are detected:
|
||||
|
||||
**Consecutive Failures**
|
||||
- Alert after X consecutive failed executions (e.g., 3 failures in a row)
|
||||
- Resets when an execution succeeds
|
||||
|
||||
**Failure Rate**
|
||||
- Alert when failure rate exceeds X% over the last Y hours
|
||||
- Requires minimum 5 executions in the window
|
||||
- Only triggers after the full time window has elapsed
|
||||
|
||||
**Latency Threshold**
|
||||
- Alert when any execution takes longer than X seconds
|
||||
- Useful for catching slow or hanging workflows
|
||||
|
||||
**Latency Spike**
|
||||
- Alert when execution is X% slower than the average
|
||||
- Compares against the average duration over the configured time window
|
||||
- Requires minimum 5 executions to establish baseline
|
||||
|
||||
**Cost Threshold**
|
||||
- Alert when a single execution costs more than $X
|
||||
- Useful for catching expensive LLM calls
|
||||
|
||||
**No Activity**
|
||||
- Alert when no executions occur within X hours
|
||||
- Useful for monitoring scheduled workflows that should run regularly
|
||||
|
||||
**Error Count**
|
||||
- Alert when error count exceeds X within a time window
|
||||
- Tracks total errors, not consecutive
|
||||
|
||||
All alert types include a 1-hour cooldown to prevent notification spam.
|
||||
|
||||
### Webhook Configuration
|
||||
|
||||
For webhooks, additional options are available:
|
||||
- `url`: Your webhook endpoint URL
|
||||
- `secret`: Optional secret for HMAC signature verification
|
||||
- `includeFinalOutput`: Include the workflow's final output in the payload
|
||||
- `includeTraceSpans`: Include detailed execution trace spans
|
||||
- `includeRateLimits`: Include the workflow owner's rate limit information
|
||||
- `includeUsageData`: Include the workflow owner's usage and billing data
|
||||
- `levelFilter`: Array of log levels to receive (`info`, `error`)
|
||||
- `triggerFilter`: Array of trigger types to receive (`api`, `webhook`, `schedule`, `manual`, `chat`)
|
||||
- `active`: Enable/disable the webhook subscription
|
||||
|
||||
### Webhook Payload
|
||||
### Payload Structure
|
||||
|
||||
When a workflow execution completes, Sim sends a POST request to your webhook URL:
|
||||
When a workflow execution completes, Sim sends the following payload (via webhook POST, email, or Slack):
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -316,7 +362,7 @@ When a workflow execution completes, Sim sends a POST request to your webhook UR
|
||||
|
||||
### Webhook Headers
|
||||
|
||||
Each webhook request includes these headers:
|
||||
Each webhook request includes these headers (webhook channel only):
|
||||
|
||||
- `sim-event`: Event type (always `workflow.execution.completed`)
|
||||
- `sim-timestamp`: Unix timestamp in milliseconds
|
||||
|
||||
@@ -147,4 +147,4 @@ The snapshot provides:
|
||||
|
||||
- Learn about [Cost Calculation](/execution/costs) to understand workflow pricing
|
||||
- Explore the [External API](/execution/api) for programmatic log access
|
||||
- Set up [Webhook notifications](/execution/api#webhook-subscriptions) for real-time alerts
|
||||
- Set up [Notifications](/execution/api#notifications) for real-time alerts via webhook, email, or Slack
|
||||
204
apps/docs/content/docs/en/tools/ahrefs.mdx
Normal file
204
apps/docs/content/docs/en/tools/ahrefs.mdx
Normal file
@@ -0,0 +1,204 @@
|
||||
---
|
||||
title: Ahrefs
|
||||
description: SEO analysis with Ahrefs
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="ahrefs"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Ahrefs](https://ahrefs.com/) is a leading SEO toolset for analyzing websites, tracking rankings, monitoring backlinks, and researching keywords. It provides detailed insights into your own website as well as your competitors, helping you make data-driven decisions to improve your search visibility.
|
||||
|
||||
With the Ahrefs integration in Sim, you can:
|
||||
|
||||
- **Analyze Domain Rating & Authority**: Instantly check the Domain Rating (DR) and Ahrefs Rank of any website to gauge its authority.
|
||||
- **Fetch Backlinks**: Retrieve a list of backlinks pointing to a site or specific URL, with details like anchor text, referring page DR, and more.
|
||||
- **Get Backlink Statistics**: Access metrics on backlink types (dofollow, nofollow, text, image, redirect, etc.) for a domain or URL.
|
||||
- **Explore Organic Keywords** *(planned)*: View keywords a domain ranks for and their positions in Google search results.
|
||||
- **Discover Top Pages** *(planned)*: Identify the highest-performing pages by organic traffic and links.
|
||||
|
||||
These tools let your agents automate SEO research, monitor competitors, and generate reports—all as part of your workflow automations. To use the Ahrefs integration, you’ll need an Ahrefs Enterprise subscription with API access.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Ahrefs SEO tools into your workflow. Analyze domain ratings, backlinks, organic keywords, top pages, and more. Requires an Ahrefs Enterprise plan with API access.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `ahrefs_domain_rating`
|
||||
|
||||
Get the Domain Rating (DR) and Ahrefs Rank for a target domain. Domain Rating shows the strength of a website
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain to analyze \(e.g., example.com\) |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `domainRating` | number | Domain Rating score \(0-100\) |
|
||||
| `ahrefsRank` | number | Ahrefs Rank - global ranking based on backlink profile strength |
|
||||
|
||||
### `ahrefs_backlinks`
|
||||
|
||||
Get a list of backlinks pointing to a target domain or URL. Returns details about each backlink including source URL, anchor text, and domain rating.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain or URL to analyze |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `backlinks` | array | List of backlinks pointing to the target |
|
||||
|
||||
### `ahrefs_backlinks_stats`
|
||||
|
||||
Get backlink statistics for a target domain or URL. Returns totals for different backlink types including dofollow, nofollow, text, image, and redirect links.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain or URL to analyze |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `stats` | object | Backlink statistics summary |
|
||||
|
||||
### `ahrefs_referring_domains`
|
||||
|
||||
Get a list of domains that link to a target domain or URL. Returns unique referring domains with their domain rating, backlink counts, and discovery dates.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain or URL to analyze |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `referringDomains` | array | List of domains linking to the target |
|
||||
|
||||
### `ahrefs_organic_keywords`
|
||||
|
||||
Get organic keywords that a target domain or URL ranks for in Google search results. Returns keyword details including search volume, ranking position, and estimated traffic.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain or URL to analyze |
|
||||
| `country` | string | No | Country code for search results \(e.g., us, gb, de\). Default: us |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `keywords` | array | List of organic keywords the target ranks for |
|
||||
|
||||
### `ahrefs_top_pages`
|
||||
|
||||
Get the top pages of a target domain sorted by organic traffic. Returns page URLs with their traffic, keyword counts, and estimated traffic value.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain to analyze |
|
||||
| `country` | string | No | Country code for traffic data \(e.g., us, gb, de\). Default: us |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\) |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pages` | array | List of top pages by organic traffic |
|
||||
|
||||
### `ahrefs_keyword_overview`
|
||||
|
||||
Get detailed metrics for a keyword including search volume, keyword difficulty, CPC, clicks, and traffic potential.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyword` | string | Yes | The keyword to analyze |
|
||||
| `country` | string | No | Country code for keyword data \(e.g., us, gb, de\). Default: us |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `overview` | object | Keyword metrics overview |
|
||||
|
||||
### `ahrefs_broken_backlinks`
|
||||
|
||||
Get a list of broken backlinks pointing to a target domain or URL. Useful for identifying link reclamation opportunities.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Yes | The target domain or URL to analyze |
|
||||
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
|
||||
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
|
||||
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
|
||||
| `offset` | number | No | Number of results to skip for pagination |
|
||||
| `apiKey` | string | Yes | Ahrefs API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `brokenBacklinks` | array | List of broken backlinks |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `ahrefs`
|
||||
94
apps/docs/content/docs/en/tools/apify.mdx
Normal file
94
apps/docs/content/docs/en/tools/apify.mdx
Normal file
@@ -0,0 +1,94 @@
|
||||
---
|
||||
title: Apify
|
||||
description: Run Apify actors and retrieve results
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="apify"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Apify](https://apify.com/) is a powerful platform for building, deploying, and running web automation and web scraping actors at scale. Apify enables you to extract useful data from any website, automate workflows, and connect your data pipelines seamlessly.
|
||||
|
||||
With Apify, you can:
|
||||
|
||||
- **Run ready-made or custom actors**: Integrate public actors or develop your own, automating a wide range of web data extraction and browser tasks.
|
||||
- **Retrieve datasets**: Access and manage structured datasets collected by actors in real time.
|
||||
- **Scale web automation**: Leverage cloud infrastructure to run tasks reliably, asynchronously or synchronously, with robust error handling.
|
||||
|
||||
In Sim, the Apify integration allows your agents to perform core Apify operations programmatically:
|
||||
|
||||
- **Run Actor (Sync)**: Use `apify_run_actor_sync` to launch an Apify actor and wait for its completion, retrieving the results as soon as the run finishes.
|
||||
- **Run Actor (Async)**: Use `apify_run_actor_async` to start an actor in the background and periodically poll for results, suitable for longer or complex jobs.
|
||||
|
||||
These operations equip your agents to automate, scrape, and orchestrate data collection or browser automation tasks directly inside workflows — all with flexible configuration and result handling, without the need for manual runs or external tools. Integrate Apify as a dynamic automation and data-extraction engine that programmatically powers your agents' web-scale workflows.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Apify into your workflow. Run any Apify actor with custom input and retrieve results. Supports both synchronous and asynchronous execution with automatic dataset fetching.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `apify_run_actor_sync`
|
||||
|
||||
Run an APIFY actor synchronously and get results (max 5 minutes)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations |
|
||||
| `actorId` | string | Yes | Actor ID or username/actor-name \(e.g., "janedoe/my-actor" or actor ID\) |
|
||||
| `input` | string | No | Actor input as JSON string. See actor documentation for required fields. |
|
||||
| `timeout` | number | No | Timeout in seconds \(default: actor default\) |
|
||||
| `build` | string | No | Actor build to run \(e.g., "latest", "beta", or build tag/number\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the actor run succeeded |
|
||||
| `runId` | string | APIFY run ID |
|
||||
| `status` | string | Run status \(SUCCEEDED, FAILED, etc.\) |
|
||||
| `datasetId` | string | Dataset ID containing results |
|
||||
| `items` | array | Dataset items \(if completed\) |
|
||||
|
||||
### `apify_run_actor_async`
|
||||
|
||||
Run an APIFY actor asynchronously with polling for long-running tasks
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations |
|
||||
| `actorId` | string | Yes | Actor ID or username/actor-name \(e.g., "janedoe/my-actor" or actor ID\) |
|
||||
| `input` | string | No | Actor input as JSON string |
|
||||
| `waitForFinish` | number | No | Initial wait time in seconds \(0-60\) before polling starts |
|
||||
| `itemLimit` | number | No | Max dataset items to fetch \(1-250000, default 100\) |
|
||||
| `timeout` | number | No | Timeout in seconds \(default: actor default\) |
|
||||
| `build` | string | No | Actor build to run \(e.g., "latest", "beta", or build tag/number\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the actor run succeeded |
|
||||
| `runId` | string | APIFY run ID |
|
||||
| `status` | string | Run status \(SUCCEEDED, FAILED, etc.\) |
|
||||
| `datasetId` | string | Dataset ID containing results |
|
||||
| `items` | array | Dataset items \(if completed\) |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `apify`
|
||||
307
apps/docs/content/docs/en/tools/datadog.mdx
Normal file
307
apps/docs/content/docs/en/tools/datadog.mdx
Normal file
@@ -0,0 +1,307 @@
|
||||
---
|
||||
title: Datadog
|
||||
description: Monitor infrastructure, applications, and logs with Datadog
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="datadog"
|
||||
color="#632CA6"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Datadog](https://datadoghq.com/) is a comprehensive monitoring and analytics platform for infrastructure, applications, logs, and more. It enables organizations to gain real-time visibility into the health and performance of systems, detect anomalies, and automate incident response.
|
||||
|
||||
With Datadog, you can:
|
||||
|
||||
- **Monitor metrics**: Collect, visualize, and analyze metrics from servers, cloud services, and custom applications.
|
||||
- **Query time series data**: Run advanced queries on performance metrics for trend analysis and reporting.
|
||||
- **Manage monitors and events**: Set up monitors to detect issues, trigger alerts, and create events for observability.
|
||||
- **Handle downtimes**: Schedule and programmatically manage planned downtimes to suppress alerts during maintenance.
|
||||
- **Analyze logs and traces** *(with additional setup in Datadog)*: Centralize and inspect logs or distributed traces for deeper troubleshooting.
|
||||
|
||||
Sim’s Datadog integration lets your agents automate these operations and interact with your Datadog account programmatically. Use it to submit custom metrics, query timeseries data, manage monitors, create events, and streamline your monitoring workflows directly within Sim automations.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Datadog monitoring into workflows. Submit metrics, manage monitors, query logs, create events, handle downtimes, and more.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `datadog_submit_metrics`
|
||||
|
||||
Submit custom metrics to Datadog. Use for tracking application performance, business metrics, or custom monitoring data.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `series` | string | Yes | JSON array of metric series to submit. Each series should include metric name, type \(gauge/rate/count\), points \(timestamp/value pairs\), and optional tags. |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the metrics were submitted successfully |
|
||||
| `errors` | array | Any errors that occurred during submission |
|
||||
|
||||
### `datadog_query_timeseries`
|
||||
|
||||
Query metric timeseries data from Datadog. Use for analyzing trends, creating reports, or retrieving metric values.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | Datadog metrics query \(e.g., "avg:system.cpu.user\{*\}"\) |
|
||||
| `from` | number | Yes | Start time as Unix timestamp in seconds |
|
||||
| `to` | number | Yes | End time as Unix timestamp in seconds |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | array | Array of timeseries data with metric name, tags, and data points |
|
||||
| `status` | string | Query status |
|
||||
|
||||
### `datadog_create_event`
|
||||
|
||||
Post an event to the Datadog event stream. Use for deployment notifications, alerts, or any significant occurrences.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `title` | string | Yes | Event title |
|
||||
| `text` | string | Yes | Event body/description. Supports markdown. |
|
||||
| `alertType` | string | No | Alert type: error, warning, info, success, user_update, recommendation, or snapshot |
|
||||
| `priority` | string | No | Event priority: normal or low |
|
||||
| `host` | string | No | Host name to associate with this event |
|
||||
| `tags` | string | No | Comma-separated list of tags \(e.g., "env:production,service:api"\) |
|
||||
| `aggregationKey` | string | No | Key to aggregate events together |
|
||||
| `sourceTypeName` | string | No | Source type name for the event |
|
||||
| `dateHappened` | number | No | Unix timestamp when the event occurred \(defaults to now\) |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | The created event details |
|
||||
|
||||
### `datadog_create_monitor`
|
||||
|
||||
Create a new monitor/alert in Datadog. Monitors can track metrics, service checks, events, and more.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `name` | string | Yes | Monitor name |
|
||||
| `type` | string | Yes | Monitor type: metric alert, service check, event alert, process alert, log alert, query alert, composite, synthetics alert, slo alert |
|
||||
| `query` | string | Yes | Monitor query \(e.g., "avg\(last_5m\):avg:system.cpu.idle\{*\} < 20"\) |
|
||||
| `message` | string | No | Message to include with notifications. Can include @-mentions and markdown. |
|
||||
| `tags` | string | No | Comma-separated list of tags |
|
||||
| `priority` | number | No | Monitor priority \(1-5, where 1 is highest\) |
|
||||
| `options` | string | No | JSON string of monitor options \(thresholds, notify_no_data, renotify_interval, etc.\) |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `monitor` | object | The created monitor details |
|
||||
|
||||
### `datadog_get_monitor`
|
||||
|
||||
Retrieve details of a specific monitor by ID.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `monitorId` | string | Yes | The ID of the monitor to retrieve |
|
||||
| `groupStates` | string | No | Comma-separated group states to include: alert, warn, no data, ok |
|
||||
| `withDowntimes` | boolean | No | Include downtime data with the monitor |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `monitor` | object | The monitor details |
|
||||
|
||||
### `datadog_list_monitors`
|
||||
|
||||
List all monitors in Datadog with optional filtering by name, tags, or state.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupStates` | string | No | Comma-separated group states to filter by: alert, warn, no data, ok |
|
||||
| `name` | string | No | Filter monitors by name \(partial match\) |
|
||||
| `tags` | string | No | Comma-separated list of tags to filter by |
|
||||
| `monitorTags` | string | No | Comma-separated list of monitor tags to filter by |
|
||||
| `withDowntimes` | boolean | No | Include downtime data with monitors |
|
||||
| `page` | number | No | Page number for pagination \(0-indexed\) |
|
||||
| `pageSize` | number | No | Number of monitors per page \(max 1000\) |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `monitors` | array | List of monitors |
|
||||
|
||||
### `datadog_mute_monitor`
|
||||
|
||||
Mute a monitor to temporarily suppress notifications.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `monitorId` | string | Yes | The ID of the monitor to mute |
|
||||
| `scope` | string | No | Scope to mute \(e.g., "host:myhost"\). If not specified, mutes all scopes. |
|
||||
| `end` | number | No | Unix timestamp when the mute should end. If not specified, mutes indefinitely. |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the monitor was successfully muted |
|
||||
|
||||
### `datadog_query_logs`
|
||||
|
||||
Search and retrieve logs from Datadog. Use for troubleshooting, analysis, or monitoring.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | Log search query \(e.g., "service:web-app status:error"\) |
|
||||
| `from` | string | Yes | Start time in ISO-8601 format or relative \(e.g., "now-1h"\) |
|
||||
| `to` | string | Yes | End time in ISO-8601 format or relative \(e.g., "now"\) |
|
||||
| `limit` | number | No | Maximum number of logs to return \(default: 50, max: 1000\) |
|
||||
| `sort` | string | No | Sort order: timestamp \(oldest first\) or -timestamp \(newest first\) |
|
||||
| `indexes` | string | No | Comma-separated list of log indexes to search |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `logs` | array | List of log entries |
|
||||
|
||||
### `datadog_send_logs`
|
||||
|
||||
Send log entries to Datadog for centralized logging and analysis.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `logs` | string | Yes | JSON array of log entries. Each entry should have message and optionally ddsource, ddtags, hostname, service. |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the logs were sent successfully |
|
||||
|
||||
### `datadog_create_downtime`
|
||||
|
||||
Schedule a downtime to suppress monitor notifications during maintenance windows.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `scope` | string | Yes | Scope to apply downtime to \(e.g., "host:myhost", "env:production", or "*" for all\) |
|
||||
| `message` | string | No | Message to display during downtime |
|
||||
| `start` | number | No | Unix timestamp for downtime start \(defaults to now\) |
|
||||
| `end` | number | No | Unix timestamp for downtime end |
|
||||
| `timezone` | string | No | Timezone for the downtime \(e.g., "America/New_York"\) |
|
||||
| `monitorId` | string | No | Specific monitor ID to mute |
|
||||
| `monitorTags` | string | No | Comma-separated monitor tags to match \(e.g., "team:backend,priority:high"\) |
|
||||
| `muteFirstRecoveryNotification` | boolean | No | Mute the first recovery notification |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `downtime` | object | The created downtime details |
|
||||
|
||||
### `datadog_list_downtimes`
|
||||
|
||||
List all scheduled downtimes in Datadog.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `currentOnly` | boolean | No | Only return currently active downtimes |
|
||||
| `monitorId` | string | No | Filter by monitor ID |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `downtimes` | array | List of downtimes |
|
||||
|
||||
### `datadog_cancel_downtime`
|
||||
|
||||
Cancel a scheduled downtime.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `downtimeId` | string | Yes | The ID of the downtime to cancel |
|
||||
| `apiKey` | string | Yes | Datadog API key |
|
||||
| `applicationKey` | string | Yes | Datadog Application key |
|
||||
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the downtime was successfully canceled |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `datadog`
|
||||
224
apps/docs/content/docs/en/tools/dropbox.mdx
Normal file
224
apps/docs/content/docs/en/tools/dropbox.mdx
Normal file
@@ -0,0 +1,224 @@
|
||||
---
|
||||
title: Dropbox
|
||||
description: Upload, download, share, and manage files in Dropbox
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="dropbox"
|
||||
color="#0061FF"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Dropbox](https://dropbox.com/) is a popular cloud storage and collaboration platform that enables individuals and teams to securely store, access, and share files from anywhere. Dropbox is designed for easy file management, syncing, and powerful collaboration, whether you're working solo or with a group.
|
||||
|
||||
With Dropbox in Sim, you can:
|
||||
|
||||
- **Upload and download files**: Seamlessly upload any file to your Dropbox or retrieve content on demand
|
||||
- **List folder contents**: Browse the files and folders within any Dropbox directory
|
||||
- **Create new folders**: Organize your files by programmatically creating new folders in your Dropbox
|
||||
- **Search files and folders**: Locate documents, images, or other items by name or content
|
||||
- **Generate shared links**: Quickly create shareable public or private links for files and folders
|
||||
- **Manage files**: Move, delete, or rename files and folders as part of automated workflows
|
||||
|
||||
These capabilities allow your Sim agents to automate Dropbox operations directly within your workflows — from backing up important files to distributing content and maintaining organized folders. Use Dropbox as both a source and destination for files, enabling seamless cloud storage management as part of your business processes.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Dropbox into your workflow for file management, sharing, and collaboration. Upload files, download content, create folders, manage shared links, and more.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `dropbox_upload`
|
||||
|
||||
Upload a file to Dropbox
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Yes | The path in Dropbox where the file should be saved \(e.g., /folder/document.pdf\) |
|
||||
| `fileContent` | string | Yes | The base64 encoded content of the file to upload |
|
||||
| `fileName` | string | No | Optional filename \(used if path is a folder\) |
|
||||
| `mode` | string | No | Write mode: add \(default\) or overwrite |
|
||||
| `autorename` | boolean | No | If true, rename the file if there is a conflict |
|
||||
| `mute` | boolean | No | If true, don't notify the user about this upload |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | object | The uploaded file metadata |
|
||||
|
||||
### `dropbox_download`
|
||||
|
||||
Download a file from Dropbox and get a temporary link
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Yes | The path of the file to download \(e.g., /folder/document.pdf\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | object | The file metadata |
|
||||
|
||||
### `dropbox_list_folder`
|
||||
|
||||
List the contents of a folder in Dropbox
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Yes | The path of the folder to list \(use "" for root\) |
|
||||
| `recursive` | boolean | No | If true, list contents recursively |
|
||||
| `includeDeleted` | boolean | No | If true, include deleted files/folders |
|
||||
| `includeMediaInfo` | boolean | No | If true, include media info for photos/videos |
|
||||
| `limit` | number | No | Maximum number of results to return \(default: 500\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `entries` | array | List of files and folders in the directory |
|
||||
|
||||
### `dropbox_create_folder`
|
||||
|
||||
Create a new folder in Dropbox
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Yes | The path where the folder should be created \(e.g., /new-folder\) |
|
||||
| `autorename` | boolean | No | If true, rename the folder if there is a conflict |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `folder` | object | The created folder metadata |
|
||||
|
||||
### `dropbox_delete`
|
||||
|
||||
Delete a file or folder in Dropbox (moves to trash)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Yes | The path of the file or folder to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadata of the deleted item |
|
||||
|
||||
### `dropbox_copy`
|
||||
|
||||
Copy a file or folder in Dropbox
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `fromPath` | string | Yes | The source path of the file or folder to copy |
|
||||
| `toPath` | string | Yes | The destination path for the copied file or folder |
|
||||
| `autorename` | boolean | No | If true, rename the file if there is a conflict at destination |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadata of the copied item |
|
||||
|
||||
### `dropbox_move`
|
||||
|
||||
Move or rename a file or folder in Dropbox
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `fromPath` | string | Yes | The source path of the file or folder to move |
|
||||
| `toPath` | string | Yes | The destination path for the moved file or folder |
|
||||
| `autorename` | boolean | No | If true, rename the file if there is a conflict at destination |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadata of the moved item |
|
||||
|
||||
### `dropbox_get_metadata`
|
||||
|
||||
Get metadata for a file or folder in Dropbox
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Yes | The path of the file or folder to get metadata for |
|
||||
| `includeMediaInfo` | boolean | No | If true, include media info for photos/videos |
|
||||
| `includeDeleted` | boolean | No | If true, include deleted files in results |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadata for the file or folder |
|
||||
|
||||
### `dropbox_create_shared_link`
|
||||
|
||||
Create a shareable link for a file or folder in Dropbox
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Yes | The path of the file or folder to share |
|
||||
| `requestedVisibility` | string | No | Visibility: public, team_only, or password |
|
||||
| `linkPassword` | string | No | Password for the shared link \(only if visibility is password\) |
|
||||
| `expires` | string | No | Expiration date in ISO 8601 format \(e.g., 2025-12-31T23:59:59Z\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `sharedLink` | object | The created shared link |
|
||||
|
||||
### `dropbox_search`
|
||||
|
||||
Search for files and folders in Dropbox
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | The search query |
|
||||
| `path` | string | No | Limit search to a specific folder path |
|
||||
| `fileExtensions` | string | No | Comma-separated list of file extensions to filter by \(e.g., pdf,xlsx\) |
|
||||
| `maxResults` | number | No | Maximum number of results to return \(default: 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `matches` | array | Search results |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `dropbox`
|
||||
193
apps/docs/content/docs/en/tools/dynamodb.mdx
Normal file
193
apps/docs/content/docs/en/tools/dynamodb.mdx
Normal file
@@ -0,0 +1,193 @@
|
||||
---
|
||||
title: Amazon DynamoDB
|
||||
description: Connect to Amazon DynamoDB
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="dynamodb"
|
||||
color="linear-gradient(45deg, #2E27AD 0%, #527FFF 100%)"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Amazon DynamoDB](https://aws.amazon.com/dynamodb/) is a fully managed NoSQL database service offered by AWS that provides fast and predictable performance with seamless scalability. DynamoDB lets you store and retrieve any amount of data and serves any level of request traffic, without the need for you to manage hardware or infrastructure.
|
||||
|
||||
With DynamoDB, you can:
|
||||
|
||||
- **Get items**: Look up items in your tables using primary keys
|
||||
- **Put items**: Add or replace items in your tables
|
||||
- **Query items**: Retrieve multiple items using queries across indexes
|
||||
- **Scan tables**: Read all or part of the data in a table
|
||||
- **Update items**: Modify specific attributes of existing items
|
||||
- **Delete items**: Remove records from your tables
|
||||
|
||||
In Sim, the DynamoDB integration enables your agents to securely access and manipulate DynamoDB tables using AWS credentials. Supported operations include:
|
||||
|
||||
- **Get**: Retrieve an item by its key
|
||||
- **Put**: Insert or overwrite items
|
||||
- **Query**: Run queries using key conditions and filters
|
||||
- **Scan**: Read multiple items by scanning the table or index
|
||||
- **Update**: Change specific attributes of one or more items
|
||||
- **Delete**: Remove an item from a table
|
||||
|
||||
This integration empowers Sim agents to automate data management tasks within your DynamoDB tables programmatically, so you can build workflows that manage, modify, and retrieve scalable NoSQL data without manual effort or server management.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Amazon DynamoDB into workflows. Supports Get, Put, Query, Scan, Update, and Delete operations on DynamoDB tables.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `dynamodb_get`
|
||||
|
||||
Get an item from a DynamoDB table by primary key
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | Yes | DynamoDB table name |
|
||||
| `key` | object | Yes | Primary key of the item to retrieve |
|
||||
| `consistentRead` | boolean | No | Use strongly consistent read |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `item` | object | Retrieved item |
|
||||
|
||||
### `dynamodb_put`
|
||||
|
||||
Put an item into a DynamoDB table
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | Yes | DynamoDB table name |
|
||||
| `item` | object | Yes | Item to put into the table |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `item` | object | Created item |
|
||||
|
||||
### `dynamodb_query`
|
||||
|
||||
Query items from a DynamoDB table using key conditions
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | Yes | DynamoDB table name |
|
||||
| `keyConditionExpression` | string | Yes | Key condition expression \(e.g., "pk = :pk"\) |
|
||||
| `filterExpression` | string | No | Filter expression for results |
|
||||
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words |
|
||||
| `expressionAttributeValues` | object | No | Expression attribute values |
|
||||
| `indexName` | string | No | Secondary index name to query |
|
||||
| `limit` | number | No | Maximum number of items to return |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `items` | array | Array of items returned |
|
||||
| `count` | number | Number of items returned |
|
||||
|
||||
### `dynamodb_scan`
|
||||
|
||||
Scan all items in a DynamoDB table
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | Yes | DynamoDB table name |
|
||||
| `filterExpression` | string | No | Filter expression for results |
|
||||
| `projectionExpression` | string | No | Attributes to retrieve |
|
||||
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words |
|
||||
| `expressionAttributeValues` | object | No | Expression attribute values |
|
||||
| `limit` | number | No | Maximum number of items to return |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `items` | array | Array of items returned |
|
||||
| `count` | number | Number of items returned |
|
||||
|
||||
### `dynamodb_update`
|
||||
|
||||
Update an item in a DynamoDB table
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | Yes | DynamoDB table name |
|
||||
| `key` | object | Yes | Primary key of the item to update |
|
||||
| `updateExpression` | string | Yes | Update expression \(e.g., "SET #name = :name"\) |
|
||||
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words |
|
||||
| `expressionAttributeValues` | object | No | Expression attribute values |
|
||||
| `conditionExpression` | string | No | Condition that must be met for the update to succeed |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `item` | object | Updated item |
|
||||
|
||||
### `dynamodb_delete`
|
||||
|
||||
Delete an item from a DynamoDB table
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `tableName` | string | Yes | DynamoDB table name |
|
||||
| `key` | object | Yes | Primary key of the item to delete |
|
||||
| `conditionExpression` | string | No | Condition that must be met for the delete to succeed |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `dynamodb`
|
||||
370
apps/docs/content/docs/en/tools/elasticsearch.mdx
Normal file
370
apps/docs/content/docs/en/tools/elasticsearch.mdx
Normal file
@@ -0,0 +1,370 @@
|
||||
---
|
||||
title: Elasticsearch
|
||||
description: Search, index, and manage data in Elasticsearch
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="elasticsearch"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Elasticsearch](https://www.elastic.co/elasticsearch/) is a powerful distributed search and analytics engine that enables you to index, search, and analyze large volumes of data in real time. It’s widely used for powering search features, log and event data analytics, observability, and more.
|
||||
|
||||
With Elasticsearch in Sim, you gain programmatic access to core Elasticsearch capabilities, including:
|
||||
|
||||
- **Search documents**: Perform advanced searches on structured or unstructured text using Query DSL, with support for sorting, pagination, and field selection.
|
||||
- **Index documents**: Add new documents or update existing ones in any Elasticsearch index for immediate retrieval and analysis.
|
||||
- **Get, update, or delete documents**: Retrieve, modify, or remove specific documents by ID.
|
||||
- **Bulk operations**: Execute multiple indexing or update actions in a single request for high-throughput data processing.
|
||||
- **Manage indexes**: Create, delete, or get details about indexes as part of your workflow automation.
|
||||
- **Cluster monitoring**: Check the health and stats of your Elasticsearch deployment.
|
||||
|
||||
Sim's Elasticsearch tools work with both self-hosted and Elastic Cloud environments. Integrate Elasticsearch into your agent workflows to automate data ingestion, search across vast datasets, run reporting, or build custom search-powered applications – all without manual intervention.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Elasticsearch into workflows for powerful search, indexing, and data management. Supports document CRUD operations, advanced search queries, bulk operations, index management, and cluster monitoring. Works with both self-hosted and Elastic Cloud deployments.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `elasticsearch_search`
|
||||
|
||||
Search documents in Elasticsearch using Query DSL. Returns matching documents with scores and metadata.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Yes | Deployment type: self_hosted or cloud |
|
||||
| `host` | string | No | Elasticsearch host URL \(for self-hosted\) |
|
||||
| `cloudId` | string | No | Elastic Cloud ID \(for cloud deployments\) |
|
||||
| `authMethod` | string | Yes | Authentication method: api_key or basic_auth |
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name to search |
|
||||
| `query` | string | No | Query DSL as JSON string |
|
||||
| `from` | number | No | Starting offset for pagination \(default: 0\) |
|
||||
| `size` | number | No | Number of results to return \(default: 10\) |
|
||||
| `sort` | string | No | Sort specification as JSON string |
|
||||
| `sourceIncludes` | string | No | Comma-separated list of fields to include in _source |
|
||||
| `sourceExcludes` | string | No | Comma-separated list of fields to exclude from _source |
|
||||
| `trackTotalHits` | boolean | No | Track accurate total hit count \(default: true\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `took` | number | Time in milliseconds the search took |
|
||||
| `timed_out` | boolean | Whether the search timed out |
|
||||
| `hits` | object | Search results with total count and matching documents |
|
||||
| `aggregations` | json | Aggregation results if any |
|
||||
|
||||
### `elasticsearch_index_document`
|
||||
|
||||
Index (create or update) a document in Elasticsearch.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Yes | Deployment type: self_hosted or cloud |
|
||||
| `host` | string | No | Elasticsearch host URL \(for self-hosted\) |
|
||||
| `cloudId` | string | No | Elastic Cloud ID \(for cloud deployments\) |
|
||||
| `authMethod` | string | Yes | Authentication method: api_key or basic_auth |
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Target index name |
|
||||
| `documentId` | string | No | Document ID \(auto-generated if not provided\) |
|
||||
| `document` | string | Yes | Document body as JSON string |
|
||||
| `refresh` | string | No | Refresh policy: true, false, or wait_for |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `_index` | string | Index where the document was stored |
|
||||
| `_id` | string | Document ID |
|
||||
| `_version` | number | Document version |
|
||||
| `result` | string | Operation result \(created or updated\) |
|
||||
|
||||
### `elasticsearch_get_document`
|
||||
|
||||
Retrieve a document by ID from Elasticsearch.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Yes | Deployment type: self_hosted or cloud |
|
||||
| `host` | string | No | Elasticsearch host URL \(for self-hosted\) |
|
||||
| `cloudId` | string | No | Elastic Cloud ID \(for cloud deployments\) |
|
||||
| `authMethod` | string | Yes | Authentication method: api_key or basic_auth |
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name |
|
||||
| `documentId` | string | Yes | Document ID to retrieve |
|
||||
| `sourceIncludes` | string | No | Comma-separated list of fields to include |
|
||||
| `sourceExcludes` | string | No | Comma-separated list of fields to exclude |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `_index` | string | Index name |
|
||||
| `_id` | string | Document ID |
|
||||
| `_version` | number | Document version |
|
||||
| `found` | boolean | Whether the document was found |
|
||||
| `_source` | json | Document content |
|
||||
|
||||
### `elasticsearch_update_document`
|
||||
|
||||
Partially update a document in Elasticsearch using doc merge.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Yes | Deployment type: self_hosted or cloud |
|
||||
| `host` | string | No | Elasticsearch host URL \(for self-hosted\) |
|
||||
| `cloudId` | string | No | Elastic Cloud ID \(for cloud deployments\) |
|
||||
| `authMethod` | string | Yes | Authentication method: api_key or basic_auth |
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name |
|
||||
| `documentId` | string | Yes | Document ID to update |
|
||||
| `document` | string | Yes | Partial document to merge as JSON string |
|
||||
| `retryOnConflict` | number | No | Number of retries on version conflict |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `_index` | string | Index name |
|
||||
| `_id` | string | Document ID |
|
||||
| `_version` | number | New document version |
|
||||
| `result` | string | Operation result \(updated or noop\) |
|
||||
|
||||
### `elasticsearch_delete_document`
|
||||
|
||||
Delete a document from Elasticsearch by ID.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Yes | Deployment type: self_hosted or cloud |
|
||||
| `host` | string | No | Elasticsearch host URL \(for self-hosted\) |
|
||||
| `cloudId` | string | No | Elastic Cloud ID \(for cloud deployments\) |
|
||||
| `authMethod` | string | Yes | Authentication method: api_key or basic_auth |
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name |
|
||||
| `documentId` | string | Yes | Document ID to delete |
|
||||
| `refresh` | string | No | Refresh policy: true, false, or wait_for |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `_index` | string | Index name |
|
||||
| `_id` | string | Document ID |
|
||||
| `_version` | number | Document version |
|
||||
| `result` | string | Operation result \(deleted or not_found\) |
|
||||
|
||||
### `elasticsearch_bulk`
|
||||
|
||||
Perform multiple index, create, delete, or update operations in a single request for high performance.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Yes | Deployment type: self_hosted or cloud |
|
||||
| `host` | string | No | Elasticsearch host URL \(for self-hosted\) |
|
||||
| `cloudId` | string | No | Elastic Cloud ID \(for cloud deployments\) |
|
||||
| `authMethod` | string | Yes | Authentication method: api_key or basic_auth |
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | No | Default index for operations that do not specify one |
|
||||
| `operations` | string | Yes | Bulk operations as NDJSON string \(newline-delimited JSON\) |
|
||||
| `refresh` | string | No | Refresh policy: true, false, or wait_for |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `took` | number | Time in milliseconds the bulk operation took |
|
||||
| `errors` | boolean | Whether any operation had an error |
|
||||
| `items` | array | Results for each operation |
|
||||
|
||||
### `elasticsearch_count`
|
||||
|
||||
Count documents matching a query in Elasticsearch.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Yes | Deployment type: self_hosted or cloud |
|
||||
| `host` | string | No | Elasticsearch host URL \(for self-hosted\) |
|
||||
| `cloudId` | string | No | Elastic Cloud ID \(for cloud deployments\) |
|
||||
| `authMethod` | string | Yes | Authentication method: api_key or basic_auth |
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name to count documents in |
|
||||
| `query` | string | No | Optional query to filter documents \(JSON string\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `count` | number | Number of documents matching the query |
|
||||
| `_shards` | object | Shard statistics |
|
||||
|
||||
### `elasticsearch_create_index`
|
||||
|
||||
Create a new index with optional settings and mappings.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Yes | Deployment type: self_hosted or cloud |
|
||||
| `host` | string | No | Elasticsearch host URL \(for self-hosted\) |
|
||||
| `cloudId` | string | No | Elastic Cloud ID \(for cloud deployments\) |
|
||||
| `authMethod` | string | Yes | Authentication method: api_key or basic_auth |
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name to create |
|
||||
| `settings` | string | No | Index settings as JSON string |
|
||||
| `mappings` | string | No | Index mappings as JSON string |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `acknowledged` | boolean | Whether the request was acknowledged |
|
||||
| `shards_acknowledged` | boolean | Whether the shards were acknowledged |
|
||||
| `index` | string | Created index name |
|
||||
|
||||
### `elasticsearch_delete_index`
|
||||
|
||||
Delete an index and all its documents. This operation is irreversible.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Yes | Deployment type: self_hosted or cloud |
|
||||
| `host` | string | No | Elasticsearch host URL \(for self-hosted\) |
|
||||
| `cloudId` | string | No | Elastic Cloud ID \(for cloud deployments\) |
|
||||
| `authMethod` | string | Yes | Authentication method: api_key or basic_auth |
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `acknowledged` | boolean | Whether the deletion was acknowledged |
|
||||
|
||||
### `elasticsearch_get_index`
|
||||
|
||||
Retrieve index information including settings, mappings, and aliases.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Yes | Deployment type: self_hosted or cloud |
|
||||
| `host` | string | No | Elasticsearch host URL \(for self-hosted\) |
|
||||
| `cloudId` | string | No | Elastic Cloud ID \(for cloud deployments\) |
|
||||
| `authMethod` | string | Yes | Authentication method: api_key or basic_auth |
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `index` | string | Yes | Index name to retrieve info for |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `index` | json | Index information including aliases, mappings, and settings |
|
||||
|
||||
### `elasticsearch_cluster_health`
|
||||
|
||||
Get the health status of the Elasticsearch cluster.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Yes | Deployment type: self_hosted or cloud |
|
||||
| `host` | string | No | Elasticsearch host URL \(for self-hosted\) |
|
||||
| `cloudId` | string | No | Elastic Cloud ID \(for cloud deployments\) |
|
||||
| `authMethod` | string | Yes | Authentication method: api_key or basic_auth |
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
| `waitForStatus` | string | No | Wait until cluster reaches this status: green, yellow, or red |
|
||||
| `timeout` | string | No | Timeout for the wait operation \(e.g., 30s, 1m\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `cluster_name` | string | Name of the cluster |
|
||||
| `status` | string | Cluster health status: green, yellow, or red |
|
||||
| `number_of_nodes` | number | Total number of nodes in the cluster |
|
||||
| `number_of_data_nodes` | number | Number of data nodes |
|
||||
| `active_shards` | number | Number of active shards |
|
||||
| `unassigned_shards` | number | Number of unassigned shards |
|
||||
|
||||
### `elasticsearch_cluster_stats`
|
||||
|
||||
Get comprehensive statistics about the Elasticsearch cluster.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Yes | Deployment type: self_hosted or cloud |
|
||||
| `host` | string | No | Elasticsearch host URL \(for self-hosted\) |
|
||||
| `cloudId` | string | No | Elastic Cloud ID \(for cloud deployments\) |
|
||||
| `authMethod` | string | Yes | Authentication method: api_key or basic_auth |
|
||||
| `apiKey` | string | No | Elasticsearch API key |
|
||||
| `username` | string | No | Username for basic auth |
|
||||
| `password` | string | No | Password for basic auth |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `cluster_name` | string | Name of the cluster |
|
||||
| `status` | string | Cluster health status |
|
||||
| `nodes` | object | Node statistics including count and versions |
|
||||
| `indices` | object | Index statistics including document count and store size |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `elasticsearch`
|
||||
434
apps/docs/content/docs/en/tools/gitlab.mdx
Normal file
434
apps/docs/content/docs/en/tools/gitlab.mdx
Normal file
@@ -0,0 +1,434 @@
|
||||
---
|
||||
title: GitLab
|
||||
description: Interact with GitLab projects, issues, merge requests, and pipelines
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="gitlab"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[GitLab](https://gitlab.com/) is a comprehensive DevOps platform that allows teams to manage, collaborate on, and automate their software development lifecycle. With GitLab, you can effortlessly handle source code management, CI/CD, reviews, and collaboration in a single application.
|
||||
|
||||
With GitLab in Sim, you can:
|
||||
|
||||
- **Manage projects and repositories**: List and retrieve your GitLab projects, access details, and organize your repositories
|
||||
- **Work with issues**: List, create, and comment on issues to track work and collaborate effectively
|
||||
- **Handle merge requests**: Review, create, and manage merge requests for code changes and peer reviews
|
||||
- **Automate CI/CD pipelines**: Trigger, monitor, and interact with GitLab pipelines as part of your automation flows
|
||||
- **Collaborate with comments**: Add comments to issues or merge requests for efficient communication within your team
|
||||
|
||||
Using Sim’s GitLab integration, your agents can programmatically interact with your GitLab projects. Automate project management, issue tracking, code reviews, and pipeline operations seamlessly in your workflows, optimizing your software development process and enhancing collaboration across your team.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate GitLab into the workflow. Can manage projects, issues, merge requests, pipelines, and add comments. Supports all core GitLab DevOps operations.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `gitlab_list_projects`
|
||||
|
||||
List GitLab projects accessible to the authenticated user
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `owned` | boolean | No | Limit to projects owned by the current user |
|
||||
| `membership` | boolean | No | Limit to projects the current user is a member of |
|
||||
| `search` | string | No | Search projects by name |
|
||||
| `visibility` | string | No | Filter by visibility \(public, internal, private\) |
|
||||
| `orderBy` | string | No | Order by field \(id, name, path, created_at, updated_at, last_activity_at\) |
|
||||
| `sort` | string | No | Sort direction \(asc, desc\) |
|
||||
| `perPage` | number | No | Number of results per page \(default 20, max 100\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `projects` | array | List of GitLab projects |
|
||||
| `total` | number | Total number of projects |
|
||||
|
||||
### `gitlab_get_project`
|
||||
|
||||
Get details of a specific GitLab project
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path \(e.g., "namespace/project"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `project` | object | The GitLab project details |
|
||||
|
||||
### `gitlab_list_issues`
|
||||
|
||||
List issues in a GitLab project
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `state` | string | No | Filter by state \(opened, closed, all\) |
|
||||
| `labels` | string | No | Comma-separated list of label names |
|
||||
| `assigneeId` | number | No | Filter by assignee user ID |
|
||||
| `milestoneTitle` | string | No | Filter by milestone title |
|
||||
| `search` | string | No | Search issues by title and description |
|
||||
| `orderBy` | string | No | Order by field \(created_at, updated_at\) |
|
||||
| `sort` | string | No | Sort direction \(asc, desc\) |
|
||||
| `perPage` | number | No | Number of results per page \(default 20, max 100\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issues` | array | List of GitLab issues |
|
||||
| `total` | number | Total number of issues |
|
||||
|
||||
### `gitlab_get_issue`
|
||||
|
||||
Get details of a specific GitLab issue
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `issueIid` | number | Yes | Issue number within the project \(the # shown in GitLab UI\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issue` | object | The GitLab issue details |
|
||||
|
||||
### `gitlab_create_issue`
|
||||
|
||||
Create a new issue in a GitLab project
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `title` | string | Yes | Issue title |
|
||||
| `description` | string | No | Issue description \(Markdown supported\) |
|
||||
| `labels` | string | No | Comma-separated list of label names |
|
||||
| `assigneeIds` | array | No | Array of user IDs to assign |
|
||||
| `milestoneId` | number | No | Milestone ID to assign |
|
||||
| `dueDate` | string | No | Due date in YYYY-MM-DD format |
|
||||
| `confidential` | boolean | No | Whether the issue is confidential |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issue` | object | The created GitLab issue |
|
||||
|
||||
### `gitlab_update_issue`
|
||||
|
||||
Update an existing issue in a GitLab project
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `issueIid` | number | Yes | Issue internal ID \(IID\) |
|
||||
| `title` | string | No | New issue title |
|
||||
| `description` | string | No | New issue description \(Markdown supported\) |
|
||||
| `stateEvent` | string | No | State event \(close or reopen\) |
|
||||
| `labels` | string | No | Comma-separated list of label names |
|
||||
| `assigneeIds` | array | No | Array of user IDs to assign |
|
||||
| `milestoneId` | number | No | Milestone ID to assign |
|
||||
| `dueDate` | string | No | Due date in YYYY-MM-DD format |
|
||||
| `confidential` | boolean | No | Whether the issue is confidential |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issue` | object | The updated GitLab issue |
|
||||
|
||||
### `gitlab_delete_issue`
|
||||
|
||||
Delete an issue from a GitLab project
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `issueIid` | number | Yes | Issue internal ID \(IID\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the issue was deleted successfully |
|
||||
|
||||
### `gitlab_create_issue_note`
|
||||
|
||||
Add a comment to a GitLab issue
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `issueIid` | number | Yes | Issue internal ID \(IID\) |
|
||||
| `body` | string | Yes | Comment body \(Markdown supported\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `note` | object | The created comment |
|
||||
|
||||
### `gitlab_list_merge_requests`
|
||||
|
||||
List merge requests in a GitLab project
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `state` | string | No | Filter by state \(opened, closed, merged, all\) |
|
||||
| `labels` | string | No | Comma-separated list of label names |
|
||||
| `sourceBranch` | string | No | Filter by source branch |
|
||||
| `targetBranch` | string | No | Filter by target branch |
|
||||
| `orderBy` | string | No | Order by field \(created_at, updated_at\) |
|
||||
| `sort` | string | No | Sort direction \(asc, desc\) |
|
||||
| `perPage` | number | No | Number of results per page \(default 20, max 100\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequests` | array | List of GitLab merge requests |
|
||||
| `total` | number | Total number of merge requests |
|
||||
|
||||
### `gitlab_get_merge_request`
|
||||
|
||||
Get details of a specific GitLab merge request
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `mergeRequestIid` | number | Yes | Merge request internal ID \(IID\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequest` | object | The GitLab merge request details |
|
||||
|
||||
### `gitlab_create_merge_request`
|
||||
|
||||
Create a new merge request in a GitLab project
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `sourceBranch` | string | Yes | Source branch name |
|
||||
| `targetBranch` | string | Yes | Target branch name |
|
||||
| `title` | string | Yes | Merge request title |
|
||||
| `description` | string | No | Merge request description \(Markdown supported\) |
|
||||
| `labels` | string | No | Comma-separated list of label names |
|
||||
| `assigneeIds` | array | No | Array of user IDs to assign |
|
||||
| `milestoneId` | number | No | Milestone ID to assign |
|
||||
| `removeSourceBranch` | boolean | No | Delete source branch after merge |
|
||||
| `squash` | boolean | No | Squash commits on merge |
|
||||
| `draft` | boolean | No | Mark as draft \(work in progress\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequest` | object | The created GitLab merge request |
|
||||
|
||||
### `gitlab_update_merge_request`
|
||||
|
||||
Update an existing merge request in a GitLab project
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `mergeRequestIid` | number | Yes | Merge request internal ID \(IID\) |
|
||||
| `title` | string | No | New merge request title |
|
||||
| `description` | string | No | New merge request description |
|
||||
| `stateEvent` | string | No | State event \(close or reopen\) |
|
||||
| `labels` | string | No | Comma-separated list of label names |
|
||||
| `assigneeIds` | array | No | Array of user IDs to assign |
|
||||
| `milestoneId` | number | No | Milestone ID to assign |
|
||||
| `targetBranch` | string | No | New target branch |
|
||||
| `removeSourceBranch` | boolean | No | Delete source branch after merge |
|
||||
| `squash` | boolean | No | Squash commits on merge |
|
||||
| `draft` | boolean | No | Mark as draft \(work in progress\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequest` | object | The updated GitLab merge request |
|
||||
|
||||
### `gitlab_merge_merge_request`
|
||||
|
||||
Merge a merge request in a GitLab project
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `mergeRequestIid` | number | Yes | Merge request internal ID \(IID\) |
|
||||
| `mergeCommitMessage` | string | No | Custom merge commit message |
|
||||
| `squashCommitMessage` | string | No | Custom squash commit message |
|
||||
| `squash` | boolean | No | Squash commits before merging |
|
||||
| `shouldRemoveSourceBranch` | boolean | No | Delete source branch after merge |
|
||||
| `mergeWhenPipelineSucceeds` | boolean | No | Merge when pipeline succeeds |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequest` | object | The merged GitLab merge request |
|
||||
|
||||
### `gitlab_create_merge_request_note`
|
||||
|
||||
Add a comment to a GitLab merge request
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `mergeRequestIid` | number | Yes | Merge request internal ID \(IID\) |
|
||||
| `body` | string | Yes | Comment body \(Markdown supported\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `note` | object | The created comment |
|
||||
|
||||
### `gitlab_list_pipelines`
|
||||
|
||||
List pipelines in a GitLab project
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `ref` | string | No | Filter by ref \(branch or tag\) |
|
||||
| `status` | string | No | Filter by status \(created, waiting_for_resource, preparing, pending, running, success, failed, canceled, skipped, manual, scheduled\) |
|
||||
| `orderBy` | string | No | Order by field \(id, status, ref, updated_at, user_id\) |
|
||||
| `sort` | string | No | Sort direction \(asc, desc\) |
|
||||
| `perPage` | number | No | Number of results per page \(default 20, max 100\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipelines` | array | List of GitLab pipelines |
|
||||
| `total` | number | Total number of pipelines |
|
||||
|
||||
### `gitlab_get_pipeline`
|
||||
|
||||
Get details of a specific GitLab pipeline
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `pipelineId` | number | Yes | Pipeline ID |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipeline` | object | The GitLab pipeline details |
|
||||
|
||||
### `gitlab_create_pipeline`
|
||||
|
||||
Trigger a new pipeline in a GitLab project
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `ref` | string | Yes | Branch or tag to run the pipeline on |
|
||||
| `variables` | array | No | Array of variables for the pipeline \(each with key, value, and optional variable_type\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipeline` | object | The created GitLab pipeline |
|
||||
|
||||
### `gitlab_retry_pipeline`
|
||||
|
||||
Retry a failed GitLab pipeline
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `pipelineId` | number | Yes | Pipeline ID |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipeline` | object | The retried GitLab pipeline |
|
||||
|
||||
### `gitlab_cancel_pipeline`
|
||||
|
||||
Cancel a running GitLab pipeline
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Project ID or URL-encoded path |
|
||||
| `pipelineId` | number | Yes | Pipeline ID |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipeline` | object | The cancelled GitLab pipeline |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `gitlab`
|
||||
@@ -45,9 +45,9 @@ Create a new event in Google Calendar
|
||||
| `summary` | string | Yes | Event title/summary |
|
||||
| `description` | string | No | Event description |
|
||||
| `location` | string | No | Event location |
|
||||
| `startDateTime` | string | Yes | Start date and time \(RFC3339 format, e.g., 2025-06-03T10:00:00-08:00\) |
|
||||
| `endDateTime` | string | Yes | End date and time \(RFC3339 format, e.g., 2025-06-03T11:00:00-08:00\) |
|
||||
| `timeZone` | string | No | Time zone \(e.g., America/Los_Angeles\) |
|
||||
| `startDateTime` | string | Yes | Start date and time. MUST include timezone offset \(e.g., 2025-06-03T10:00:00-08:00\) OR provide timeZone parameter |
|
||||
| `endDateTime` | string | Yes | End date and time. MUST include timezone offset \(e.g., 2025-06-03T11:00:00-08:00\) OR provide timeZone parameter |
|
||||
| `timeZone` | string | No | Time zone \(e.g., America/Los_Angeles\). Required if datetime does not include offset. Defaults to America/Los_Angeles if not provided. |
|
||||
| `attendees` | array | No | Array of attendee email addresses |
|
||||
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none |
|
||||
|
||||
|
||||
@@ -113,8 +113,8 @@ List files and folders in Google Drive
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `folderSelector` | string | No | Select the folder to list files from |
|
||||
| `folderId` | string | No | The ID of the folder to list files from \(internal use\) |
|
||||
| `query` | string | No | A query to filter the files |
|
||||
| `pageSize` | number | No | The number of files to return |
|
||||
| `query` | string | No | Search term to filter files by name \(e.g. "budget" finds files with "budget" in the name\). Do NOT use Google Drive query syntax here - just provide a plain search term. |
|
||||
| `pageSize` | number | No | The maximum number of files to return \(default: 100\) |
|
||||
| `pageToken` | string | No | The page token to use for pagination |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -91,8 +91,8 @@ Read data from a Google Sheets spreadsheet
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet to read from |
|
||||
| `range` | string | No | The range of cells to read from |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet \(found in the URL: docs.google.com/spreadsheets/d/\{SPREADSHEET_ID\}/edit\). |
|
||||
| `range` | string | No | The A1 notation range to read \(e.g. "Sheet1!A1:D10", "A1:B5"\). Defaults to first sheet A1:Z1000 if not specified. |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -109,9 +109,9 @@ Write data to a Google Sheets spreadsheet
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet to write to |
|
||||
| `range` | string | No | The range of cells to write to |
|
||||
| `values` | array | Yes | The data to write to the spreadsheet |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet |
|
||||
| `range` | string | No | The A1 notation range to write to \(e.g. "Sheet1!A1:D10", "A1:B5"\) |
|
||||
| `values` | array | Yes | The data to write as a 2D array \(e.g. \[\["Name", "Age"\], \["Alice", 30\], \["Bob", 25\]\]\) or array of objects. |
|
||||
| `valueInputOption` | string | No | The format of the data to write |
|
||||
| `includeValuesInResponse` | boolean | No | Whether to include the written values in the response |
|
||||
|
||||
@@ -134,8 +134,8 @@ Update data in a Google Sheets spreadsheet
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet to update |
|
||||
| `range` | string | No | The range of cells to update |
|
||||
| `values` | array | Yes | The data to update in the spreadsheet |
|
||||
| `range` | string | No | The A1 notation range to update \(e.g. "Sheet1!A1:D10", "A1:B5"\) |
|
||||
| `values` | array | Yes | The data to update as a 2D array \(e.g. \[\["Name", "Age"\], \["Alice", 30\]\]\) or array of objects. |
|
||||
| `valueInputOption` | string | No | The format of the data to update |
|
||||
| `includeValuesInResponse` | boolean | No | Whether to include the updated values in the response |
|
||||
|
||||
@@ -158,8 +158,8 @@ Append data to the end of a Google Sheets spreadsheet
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `spreadsheetId` | string | Yes | The ID of the spreadsheet to append to |
|
||||
| `range` | string | No | The range of cells to append after |
|
||||
| `values` | array | Yes | The data to append to the spreadsheet |
|
||||
| `range` | string | No | The A1 notation range to append after \(e.g. "Sheet1", "Sheet1!A:D"\) |
|
||||
| `values` | array | Yes | The data to append as a 2D array \(e.g. \[\["Alice", 30\], \["Bob", 25\]\]\) or array of objects. |
|
||||
| `valueInputOption` | string | No | The format of the data to append |
|
||||
| `insertDataOption` | string | No | How to insert the data \(OVERWRITE or INSERT_ROWS\) |
|
||||
| `includeValuesInResponse` | boolean | No | Whether to include the appended values in the response |
|
||||
|
||||
499
apps/docs/content/docs/en/tools/grafana.mdx
Normal file
499
apps/docs/content/docs/en/tools/grafana.mdx
Normal file
@@ -0,0 +1,499 @@
|
||||
---
|
||||
title: Grafana
|
||||
description: Interact with Grafana dashboards, alerts, and annotations
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="grafana"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Grafana](https://grafana.com/) is a leading open-source platform for monitoring, observability, and visualization. It allows users to query, visualize, alert on, and analyze data from a variety of sources, making it an essential tool for infrastructure and application monitoring.
|
||||
|
||||
With Grafana, you can:
|
||||
|
||||
- **Visualize data**: Build and customize dashboards to display metrics, logs, and traces in real time
|
||||
- **Monitor health and status**: Check the health of your Grafana instance and connected data sources
|
||||
- **Manage alerts and annotations**: Set up alert rules, manage notifications, and annotate dashboards with important events
|
||||
- **Organize content**: Organize dashboards and data sources into folders for better access management
|
||||
|
||||
In Sim, the Grafana integration empowers your agents to interact directly with your Grafana instance via API, enabling actions such as:
|
||||
|
||||
- Checking the Grafana server, database, and data source health status
|
||||
- Retrieving, listing, and managing dashboards, alert rules, annotations, data sources, and folders
|
||||
- Automating the monitoring of your infrastructure by integrating Grafana data and alerts into your workflow automations
|
||||
|
||||
These capabilities enable Sim agents to monitor systems, proactively respond to alerts, and help ensure the reliability and visibility of your services — all as part of your automated workflows.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Grafana into workflows. Manage dashboards, alerts, annotations, data sources, folders, and monitor health status.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `grafana_get_dashboard`
|
||||
|
||||
Get a dashboard by its UID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `dashboardUid` | string | Yes | The UID of the dashboard to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `dashboard` | json | The full dashboard JSON object |
|
||||
| `meta` | json | Dashboard metadata \(version, permissions, etc.\) |
|
||||
|
||||
### `grafana_list_dashboards`
|
||||
|
||||
Search and list all dashboards
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `query` | string | No | Search query to filter dashboards by title |
|
||||
| `tag` | string | No | Filter by tag \(comma-separated for multiple tags\) |
|
||||
| `folderIds` | string | No | Filter by folder IDs \(comma-separated\) |
|
||||
| `starred` | boolean | No | Only return starred dashboards |
|
||||
| `limit` | number | No | Maximum number of dashboards to return |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `dashboards` | array | List of dashboard search results |
|
||||
|
||||
### `grafana_create_dashboard`
|
||||
|
||||
Create a new dashboard
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `title` | string | Yes | The title of the new dashboard |
|
||||
| `folderUid` | string | No | The UID of the folder to create the dashboard in |
|
||||
| `tags` | string | No | Comma-separated list of tags |
|
||||
| `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) |
|
||||
| `refresh` | string | No | Auto-refresh interval \(e.g., 5s, 1m, 5m\) |
|
||||
| `panels` | string | No | JSON array of panel configurations |
|
||||
| `overwrite` | boolean | No | Overwrite existing dashboard with same title |
|
||||
| `message` | string | No | Commit message for the dashboard version |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | The numeric ID of the created dashboard |
|
||||
| `uid` | string | The UID of the created dashboard |
|
||||
| `url` | string | The URL path to the dashboard |
|
||||
| `status` | string | Status of the operation \(success\) |
|
||||
| `version` | number | The version number of the dashboard |
|
||||
| `slug` | string | URL-friendly slug of the dashboard |
|
||||
|
||||
### `grafana_update_dashboard`
|
||||
|
||||
Update an existing dashboard. Fetches the current dashboard and merges your changes.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `dashboardUid` | string | Yes | The UID of the dashboard to update |
|
||||
| `title` | string | No | New title for the dashboard |
|
||||
| `folderUid` | string | No | New folder UID to move the dashboard to |
|
||||
| `tags` | string | No | Comma-separated list of new tags |
|
||||
| `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) |
|
||||
| `refresh` | string | No | Auto-refresh interval \(e.g., 5s, 1m, 5m\) |
|
||||
| `panels` | string | No | JSON array of panel configurations |
|
||||
| `overwrite` | boolean | No | Overwrite even if there is a version conflict |
|
||||
| `message` | string | No | Commit message for this version |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | The numeric ID of the updated dashboard |
|
||||
| `uid` | string | The UID of the updated dashboard |
|
||||
| `url` | string | The URL path to the dashboard |
|
||||
| `status` | string | Status of the operation \(success\) |
|
||||
| `version` | number | The new version number of the dashboard |
|
||||
| `slug` | string | URL-friendly slug of the dashboard |
|
||||
|
||||
### `grafana_delete_dashboard`
|
||||
|
||||
Delete a dashboard by its UID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `dashboardUid` | string | Yes | The UID of the dashboard to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `title` | string | The title of the deleted dashboard |
|
||||
| `message` | string | Confirmation message |
|
||||
| `id` | number | The ID of the deleted dashboard |
|
||||
|
||||
### `grafana_list_alert_rules`
|
||||
|
||||
List all alert rules in the Grafana instance
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `rules` | array | List of alert rules |
|
||||
|
||||
### `grafana_get_alert_rule`
|
||||
|
||||
Get a specific alert rule by its UID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `alertRuleUid` | string | Yes | The UID of the alert rule to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `uid` | string | Alert rule UID |
|
||||
| `title` | string | Alert rule title |
|
||||
| `condition` | string | Alert condition |
|
||||
| `data` | json | Alert rule query data |
|
||||
| `folderUID` | string | Parent folder UID |
|
||||
| `ruleGroup` | string | Rule group name |
|
||||
| `noDataState` | string | State when no data is returned |
|
||||
| `execErrState` | string | State on execution error |
|
||||
| `annotations` | json | Alert annotations |
|
||||
| `labels` | json | Alert labels |
|
||||
|
||||
### `grafana_create_alert_rule`
|
||||
|
||||
Create a new alert rule
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `title` | string | Yes | The title of the alert rule |
|
||||
| `folderUid` | string | Yes | The UID of the folder to create the alert in |
|
||||
| `ruleGroup` | string | Yes | The name of the rule group |
|
||||
| `condition` | string | Yes | The refId of the query or expression to use as the alert condition |
|
||||
| `data` | string | Yes | JSON array of query/expression data objects |
|
||||
| `forDuration` | string | No | Duration to wait before firing \(e.g., 5m, 1h\) |
|
||||
| `noDataState` | string | No | State when no data is returned \(NoData, Alerting, OK\) |
|
||||
| `execErrState` | string | No | State on execution error \(Alerting, OK\) |
|
||||
| `annotations` | string | No | JSON object of annotations |
|
||||
| `labels` | string | No | JSON object of labels |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `uid` | string | The UID of the created alert rule |
|
||||
| `title` | string | Alert rule title |
|
||||
| `folderUID` | string | Parent folder UID |
|
||||
| `ruleGroup` | string | Rule group name |
|
||||
|
||||
### `grafana_update_alert_rule`
|
||||
|
||||
Update an existing alert rule. Fetches the current rule and merges your changes.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `alertRuleUid` | string | Yes | The UID of the alert rule to update |
|
||||
| `title` | string | No | New title for the alert rule |
|
||||
| `folderUid` | string | No | New folder UID to move the alert to |
|
||||
| `ruleGroup` | string | No | New rule group name |
|
||||
| `condition` | string | No | New condition refId |
|
||||
| `data` | string | No | New JSON array of query/expression data objects |
|
||||
| `forDuration` | string | No | Duration to wait before firing \(e.g., 5m, 1h\) |
|
||||
| `noDataState` | string | No | State when no data is returned \(NoData, Alerting, OK\) |
|
||||
| `execErrState` | string | No | State on execution error \(Alerting, OK\) |
|
||||
| `annotations` | string | No | JSON object of annotations |
|
||||
| `labels` | string | No | JSON object of labels |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `uid` | string | The UID of the updated alert rule |
|
||||
| `title` | string | Alert rule title |
|
||||
| `folderUID` | string | Parent folder UID |
|
||||
| `ruleGroup` | string | Rule group name |
|
||||
|
||||
### `grafana_delete_alert_rule`
|
||||
|
||||
Delete an alert rule by its UID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `alertRuleUid` | string | Yes | The UID of the alert rule to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Confirmation message |
|
||||
|
||||
### `grafana_list_contact_points`
|
||||
|
||||
List all alert notification contact points
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contactPoints` | array | List of contact points |
|
||||
|
||||
### `grafana_create_annotation`
|
||||
|
||||
Create an annotation on a dashboard or as a global annotation
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `text` | string | Yes | The text content of the annotation |
|
||||
| `tags` | string | No | Comma-separated list of tags |
|
||||
| `dashboardUid` | string | No | UID of the dashboard to add the annotation to \(optional for global annotations\) |
|
||||
| `panelId` | number | No | ID of the panel to add the annotation to |
|
||||
| `time` | number | No | Start time in epoch milliseconds \(defaults to now\) |
|
||||
| `timeEnd` | number | No | End time in epoch milliseconds \(for range annotations\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | The ID of the created annotation |
|
||||
| `message` | string | Confirmation message |
|
||||
|
||||
### `grafana_list_annotations`
|
||||
|
||||
Query annotations by time range, dashboard, or tags
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `from` | number | No | Start time in epoch milliseconds |
|
||||
| `to` | number | No | End time in epoch milliseconds |
|
||||
| `dashboardUid` | string | No | Filter by dashboard UID |
|
||||
| `panelId` | number | No | Filter by panel ID |
|
||||
| `tags` | string | No | Comma-separated list of tags to filter by |
|
||||
| `type` | string | No | Filter by type \(alert or annotation\) |
|
||||
| `limit` | number | No | Maximum number of annotations to return |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `annotations` | array | List of annotations |
|
||||
|
||||
### `grafana_update_annotation`
|
||||
|
||||
Update an existing annotation
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `annotationId` | number | Yes | The ID of the annotation to update |
|
||||
| `text` | string | Yes | New text content for the annotation |
|
||||
| `tags` | string | No | Comma-separated list of new tags |
|
||||
| `time` | number | No | New start time in epoch milliseconds |
|
||||
| `timeEnd` | number | No | New end time in epoch milliseconds |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | The ID of the updated annotation |
|
||||
| `message` | string | Confirmation message |
|
||||
|
||||
### `grafana_delete_annotation`
|
||||
|
||||
Delete an annotation by its ID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `annotationId` | number | Yes | The ID of the annotation to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Confirmation message |
|
||||
|
||||
### `grafana_list_data_sources`
|
||||
|
||||
List all data sources configured in Grafana
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `dataSources` | array | List of data sources |
|
||||
|
||||
### `grafana_get_data_source`
|
||||
|
||||
Get a data source by its ID or UID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `dataSourceId` | string | Yes | The ID or UID of the data source to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | Data source ID |
|
||||
| `uid` | string | Data source UID |
|
||||
| `name` | string | Data source name |
|
||||
| `type` | string | Data source type |
|
||||
| `url` | string | Data source connection URL |
|
||||
| `database` | string | Database name \(if applicable\) |
|
||||
| `isDefault` | boolean | Whether this is the default data source |
|
||||
| `jsonData` | json | Additional data source configuration |
|
||||
|
||||
### `grafana_list_folders`
|
||||
|
||||
List all folders in Grafana
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `limit` | number | No | Maximum number of folders to return |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `folders` | array | List of folders |
|
||||
|
||||
### `grafana_create_folder`
|
||||
|
||||
Create a new folder in Grafana
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Grafana Service Account Token |
|
||||
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | Organization ID for multi-org Grafana instances |
|
||||
| `title` | string | Yes | The title of the new folder |
|
||||
| `uid` | string | No | Optional UID for the folder \(auto-generated if not provided\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | The numeric ID of the created folder |
|
||||
| `uid` | string | The UID of the created folder |
|
||||
| `title` | string | The title of the created folder |
|
||||
| `url` | string | The URL path to the folder |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `grafana`
|
||||
300
apps/docs/content/docs/en/tools/kalshi.mdx
Normal file
300
apps/docs/content/docs/en/tools/kalshi.mdx
Normal file
@@ -0,0 +1,300 @@
|
||||
---
|
||||
title: Kalshi
|
||||
description: Access prediction markets data from Kalshi
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="kalshi"
|
||||
color="#09C285"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Kalshi](https://kalshi.com) is a federally regulated exchange where users can trade directly on the outcomes of future events—prediction markets. Kalshi’s robust API and Sim integration enable agents and workflows to programmatically access all aspects of the platform, supporting everything from research and analytics to automated trading and monitoring.
|
||||
|
||||
With Kalshi’s integration in Sim, you can:
|
||||
|
||||
- **Market & Event Data:** Search, filter, and retrieve real-time and historical data for markets and events; fetch granular details on market status, series, event groupings, and more.
|
||||
- **Account & Balance Management:** Access account balances, available funds, and monitor real-time open positions.
|
||||
- **Order & Trade Management:** Place new orders, cancel existing ones, view open orders, retrieve a live orderbook, and access complete trade histories.
|
||||
- **Execution Analysis:** Fetch recent trades, historical fills, and candlestick data for backtesting or market structure research.
|
||||
- **Monitoring:** Check exchange-wide or series-level status, receive real-time updates about market changes or trading halts, and automate responses.
|
||||
- **Automation Ready:** Build end-to-end automated agents and dashboards that consume, analyze, and trade on real-world event probabilities.
|
||||
|
||||
By using these unified tools and endpoints, you can seamlessly incorporate Kalshi’s prediction markets, live trading capabilities, and deep event data into your AI-powered applications, dashboards, and workflows—enabling sophisticated, automated decision-making tied to real-world outcomes.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Kalshi prediction markets into the workflow. Can get markets, market, events, event, balance, positions, orders, orderbook, trades, candlesticks, fills, series, and exchange status.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `kalshi_get_markets`
|
||||
|
||||
Retrieve a list of prediction markets from Kalshi with optional filtering
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `status` | string | No | Filter by status \(unopened, open, closed, settled\) |
|
||||
| `seriesTicker` | string | No | Filter by series ticker |
|
||||
| `eventTicker` | string | No | Filter by event ticker |
|
||||
| `limit` | string | No | Number of results \(1-1000, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Markets data and metadata |
|
||||
|
||||
### `kalshi_get_market`
|
||||
|
||||
Retrieve details of a specific prediction market by ticker
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `ticker` | string | Yes | The market ticker \(e.g., "KXBTC-24DEC31"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Market data and metadata |
|
||||
|
||||
### `kalshi_get_events`
|
||||
|
||||
Retrieve a list of events from Kalshi with optional filtering
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `status` | string | No | Filter by status \(open, closed, settled\) |
|
||||
| `seriesTicker` | string | No | Filter by series ticker |
|
||||
| `withNestedMarkets` | string | No | Include nested markets in response \(true/false\) |
|
||||
| `limit` | string | No | Number of results \(1-200, default: 200\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Events data and metadata |
|
||||
|
||||
### `kalshi_get_event`
|
||||
|
||||
Retrieve details of a specific event by ticker
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `eventTicker` | string | Yes | The event ticker |
|
||||
| `withNestedMarkets` | string | No | Include nested markets in response \(true/false\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Event data and metadata |
|
||||
|
||||
### `kalshi_get_balance`
|
||||
|
||||
Retrieve your account balance and portfolio value from Kalshi
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Balance data and metadata |
|
||||
|
||||
### `kalshi_get_positions`
|
||||
|
||||
Retrieve your open positions from Kalshi
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||
| `ticker` | string | No | Filter by market ticker |
|
||||
| `eventTicker` | string | No | Filter by event ticker \(max 10 comma-separated\) |
|
||||
| `settlementStatus` | string | No | Filter by settlement status \(all, unsettled, settled\). Default: unsettled |
|
||||
| `limit` | string | No | Number of results \(1-1000, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Positions data and metadata |
|
||||
|
||||
### `kalshi_get_orders`
|
||||
|
||||
Retrieve your orders from Kalshi with optional filtering
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||
| `ticker` | string | No | Filter by market ticker |
|
||||
| `eventTicker` | string | No | Filter by event ticker \(max 10 comma-separated\) |
|
||||
| `status` | string | No | Filter by status \(resting, canceled, executed\) |
|
||||
| `limit` | string | No | Number of results \(1-200, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Orders data and metadata |
|
||||
|
||||
### `kalshi_get_orderbook`
|
||||
|
||||
Retrieve the orderbook (bids and asks) for a specific market
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) |
|
||||
| `depth` | number | No | Number of price levels to return per side |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Orderbook data and metadata |
|
||||
|
||||
### `kalshi_get_trades`
|
||||
|
||||
Retrieve recent trades across all markets or for a specific market
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `ticker` | string | No | Filter by market ticker |
|
||||
| `minTs` | number | No | Minimum timestamp \(Unix milliseconds\) |
|
||||
| `maxTs` | number | No | Maximum timestamp \(Unix milliseconds\) |
|
||||
| `limit` | string | No | Number of results \(1-1000, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Trades data and metadata |
|
||||
|
||||
### `kalshi_get_candlesticks`
|
||||
|
||||
Retrieve OHLC candlestick data for a specific market
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `seriesTicker` | string | Yes | Series ticker |
|
||||
| `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) |
|
||||
| `startTs` | number | No | Start timestamp \(Unix milliseconds\) |
|
||||
| `endTs` | number | No | End timestamp \(Unix milliseconds\) |
|
||||
| `periodInterval` | number | No | Period interval: 1 \(1min\), 60 \(1hour\), or 1440 \(1day\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Candlestick data and metadata |
|
||||
|
||||
### `kalshi_get_fills`
|
||||
|
||||
Retrieve your portfolio
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Yes | Your Kalshi API Key ID |
|
||||
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
|
||||
| `ticker` | string | No | Filter by market ticker |
|
||||
| `orderId` | string | No | Filter by order ID |
|
||||
| `minTs` | number | No | Minimum timestamp \(Unix milliseconds\) |
|
||||
| `maxTs` | number | No | Maximum timestamp \(Unix milliseconds\) |
|
||||
| `limit` | string | No | Number of results \(1-1000, default: 100\) |
|
||||
| `cursor` | string | No | Pagination cursor for next page |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Fills data and metadata |
|
||||
|
||||
### `kalshi_get_series_by_ticker`
|
||||
|
||||
Retrieve details of a specific market series by ticker
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `seriesTicker` | string | Yes | Series ticker |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Series data and metadata |
|
||||
|
||||
### `kalshi_get_exchange_status`
|
||||
|
||||
Retrieve the current status of the Kalshi exchange (trading and exchange activity)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Exchange status data and metadata |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `kalshi`
|
||||
88
apps/docs/content/docs/en/tools/linkedin.mdx
Normal file
88
apps/docs/content/docs/en/tools/linkedin.mdx
Normal file
@@ -0,0 +1,88 @@
|
||||
---
|
||||
title: LinkedIn
|
||||
description: Share posts and manage your LinkedIn presence
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="linkedin"
|
||||
color="#0072B1"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[LinkedIn](https://www.linkedin.com) is the world’s largest professional networking platform, empowering users to build their careers, connect with their network, and share professional content. LinkedIn is widely used by professionals across industries for personal branding, recruiting, job search, and business development.
|
||||
|
||||
With LinkedIn, you can easily share posts to your personal feed to engage with your network, and access information about your profile to highlight your professional achievements. Automated integration with Sim allows you to leverage LinkedIn functionality programmatically—enabling agents and workflows to post updates, report on your professional presence, and keep your feed active without manual effort.
|
||||
|
||||
Key LinkedIn features available through this integration include:
|
||||
|
||||
- **Share Posts:** Automatically publish professional updates, articles, or announcements to your LinkedIn personal feed.
|
||||
- **Profile Information:** Retrieve detailed information about your LinkedIn profile to monitor or use in downstream tasks within your workflows.
|
||||
|
||||
These capabilities make it easy to keep your LinkedIn network engaged and to extend your professional reach efficiently as part of your AI or workflow automation strategy.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate LinkedIn into workflows. Share posts to your personal feed and access your LinkedIn profile information.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `linkedin_share_post`
|
||||
|
||||
Share a post to your personal LinkedIn feed
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `text` | string | Yes | The text content of your LinkedIn post |
|
||||
| `visibility` | string | No | Who can see this post: "PUBLIC" or "CONNECTIONS" \(default: "PUBLIC"\) |
|
||||
| `request` | string | No | No description |
|
||||
| `output` | string | No | No description |
|
||||
| `output` | string | No | No description |
|
||||
| `specificContent` | string | No | No description |
|
||||
| `shareCommentary` | string | No | No description |
|
||||
| `visibility` | string | No | No description |
|
||||
| `headers` | string | No | No description |
|
||||
| `output` | string | No | No description |
|
||||
| `output` | string | No | No description |
|
||||
| `output` | string | No | No description |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `postId` | string | Created post ID |
|
||||
| `profile` | json | LinkedIn profile information |
|
||||
| `error` | string | Error message if operation failed |
|
||||
|
||||
### `linkedin_get_profile`
|
||||
|
||||
Retrieve your LinkedIn profile information
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `postId` | string | Created post ID |
|
||||
| `profile` | json | LinkedIn profile information |
|
||||
| `error` | string | Error message if operation failed |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `linkedin`
|
||||
221
apps/docs/content/docs/en/tools/mailgun.mdx
Normal file
221
apps/docs/content/docs/en/tools/mailgun.mdx
Normal file
@@ -0,0 +1,221 @@
|
||||
---
|
||||
title: Mailgun
|
||||
description: Send emails and manage mailing lists with Mailgun
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="mailgun"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Mailgun](https://www.mailgun.com) is a powerful email delivery service designed for developers and businesses to send, receive, and track emails effortlessly. Mailgun enables you to leverage robust APIs for reliable transactional and marketing email, flexible mailing list management, and advanced event tracking.
|
||||
|
||||
With Mailgun's comprehensive feature set, you can automate key email operations and closely monitor deliverability and recipient engagement. This makes it an ideal solution for workflow automation where communications, notifications, and campaign mails are core parts of your processes.
|
||||
|
||||
Key features of Mailgun include:
|
||||
|
||||
- **Transactional Email Sending:** Deliver high-volume emails such as account notifications, receipts, alerts, and password resets.
|
||||
- **Rich Email Content:** Send both plain text and HTML emails, and use tags for categorizing and tracking your messages.
|
||||
- **Mailing List Management:** Create, update, and manage mailing lists and members to send grouped communications efficiently.
|
||||
- **Domain Information:** Retrieve details about your sending domains to monitor configuration and health.
|
||||
- **Event Tracking:** Analyze email deliverability and engagement with detailed event data on sent messages.
|
||||
- **Message Retrieval:** Access stored messages for compliance, analysis, or troubleshooting needs.
|
||||
|
||||
By integrating Mailgun into Sim, your agents are empowered to programmatically send emails, manage email lists, access domain information, and monitor real-time events as part of automated workflows. This allows for intelligent, data-driven engagement with your users directly from your AI-powered processes.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Mailgun into your workflow. Send transactional emails, manage mailing lists and members, view domain information, and track email events. Supports text and HTML emails, tags for tracking, and comprehensive list management.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `mailgun_send_message`
|
||||
|
||||
Send an email using Mailgun API
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `domain` | string | Yes | Mailgun domain \(e.g., mg.example.com\) |
|
||||
| `from` | string | Yes | Sender email address |
|
||||
| `to` | string | Yes | Recipient email address \(comma-separated for multiple\) |
|
||||
| `subject` | string | Yes | Email subject |
|
||||
| `text` | string | No | Plain text body of the email |
|
||||
| `html` | string | No | HTML body of the email |
|
||||
| `cc` | string | No | CC email address \(comma-separated for multiple\) |
|
||||
| `bcc` | string | No | BCC email address \(comma-separated for multiple\) |
|
||||
| `tags` | string | No | Tags for the email \(comma-separated\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the message was sent successfully |
|
||||
| `id` | string | Message ID |
|
||||
| `message` | string | Response message from Mailgun |
|
||||
|
||||
### `mailgun_get_message`
|
||||
|
||||
Retrieve a stored message by its key
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `domain` | string | Yes | Mailgun domain |
|
||||
| `messageKey` | string | Yes | Message storage key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the request was successful |
|
||||
| `recipients` | string | Message recipients |
|
||||
| `from` | string | Sender email |
|
||||
| `subject` | string | Message subject |
|
||||
| `bodyPlain` | string | Plain text body |
|
||||
| `strippedText` | string | Stripped text |
|
||||
| `strippedSignature` | string | Stripped signature |
|
||||
| `bodyHtml` | string | HTML body |
|
||||
| `strippedHtml` | string | Stripped HTML |
|
||||
| `attachmentCount` | number | Number of attachments |
|
||||
| `timestamp` | number | Message timestamp |
|
||||
| `messageHeaders` | json | Message headers |
|
||||
| `contentIdMap` | json | Content ID map |
|
||||
|
||||
### `mailgun_list_messages`
|
||||
|
||||
List events (logs) for messages sent through Mailgun
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `domain` | string | Yes | Mailgun domain |
|
||||
| `event` | string | No | Filter by event type \(accepted, delivered, failed, opened, clicked, etc.\) |
|
||||
| `limit` | number | No | Maximum number of events to return \(default: 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the request was successful |
|
||||
| `items` | json | Array of event items |
|
||||
| `paging` | json | Paging information |
|
||||
|
||||
### `mailgun_create_mailing_list`
|
||||
|
||||
Create a new mailing list
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `address` | string | Yes | Mailing list address \(e.g., list@example.com\) |
|
||||
| `name` | string | No | Mailing list name |
|
||||
| `description` | string | No | Mailing list description |
|
||||
| `accessLevel` | string | No | Access level: readonly, members, or everyone |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the list was created successfully |
|
||||
| `message` | string | Response message |
|
||||
| `list` | json | Created mailing list details |
|
||||
|
||||
### `mailgun_get_mailing_list`
|
||||
|
||||
Get details of a mailing list
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `address` | string | Yes | Mailing list address |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the request was successful |
|
||||
| `list` | json | Mailing list details |
|
||||
|
||||
### `mailgun_add_list_member`
|
||||
|
||||
Add a member to a mailing list
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `listAddress` | string | Yes | Mailing list address |
|
||||
| `address` | string | Yes | Member email address |
|
||||
| `name` | string | No | Member name |
|
||||
| `vars` | string | No | JSON string of custom variables |
|
||||
| `subscribed` | boolean | No | Whether the member is subscribed |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the member was added successfully |
|
||||
| `message` | string | Response message |
|
||||
| `member` | json | Added member details |
|
||||
|
||||
### `mailgun_list_domains`
|
||||
|
||||
List all domains for your Mailgun account
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the request was successful |
|
||||
| `totalCount` | number | Total number of domains |
|
||||
| `items` | json | Array of domain objects |
|
||||
|
||||
### `mailgun_get_domain`
|
||||
|
||||
Get details of a specific domain
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | Mailgun API key |
|
||||
| `domain` | string | Yes | Domain name |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the request was successful |
|
||||
| `domain` | json | Domain details |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `mailgun`
|
||||
@@ -1,7 +1,9 @@
|
||||
{
|
||||
"pages": [
|
||||
"index",
|
||||
"ahrefs",
|
||||
"airtable",
|
||||
"apify",
|
||||
"apollo",
|
||||
"arxiv",
|
||||
"asana",
|
||||
@@ -9,12 +11,17 @@
|
||||
"calendly",
|
||||
"clay",
|
||||
"confluence",
|
||||
"datadog",
|
||||
"discord",
|
||||
"dropbox",
|
||||
"dynamodb",
|
||||
"elasticsearch",
|
||||
"elevenlabs",
|
||||
"exa",
|
||||
"file",
|
||||
"firecrawl",
|
||||
"github",
|
||||
"gitlab",
|
||||
"gmail",
|
||||
"google_calendar",
|
||||
"google_docs",
|
||||
@@ -23,6 +30,7 @@
|
||||
"google_search",
|
||||
"google_sheets",
|
||||
"google_vault",
|
||||
"grafana",
|
||||
"hubspot",
|
||||
"huggingface",
|
||||
"hunter",
|
||||
@@ -31,10 +39,13 @@
|
||||
"intercom",
|
||||
"jina",
|
||||
"jira",
|
||||
"kalshi",
|
||||
"knowledge",
|
||||
"linear",
|
||||
"linkedin",
|
||||
"linkup",
|
||||
"mailchimp",
|
||||
"mailgun",
|
||||
"mem0",
|
||||
"memory",
|
||||
"microsoft_excel",
|
||||
@@ -52,18 +63,25 @@
|
||||
"perplexity",
|
||||
"pinecone",
|
||||
"pipedrive",
|
||||
"polymarket",
|
||||
"postgresql",
|
||||
"posthog",
|
||||
"pylon",
|
||||
"qdrant",
|
||||
"rds",
|
||||
"reddit",
|
||||
"resend",
|
||||
"s3",
|
||||
"salesforce",
|
||||
"search",
|
||||
"sendgrid",
|
||||
"sentry",
|
||||
"serper",
|
||||
"sharepoint",
|
||||
"shopify",
|
||||
"slack",
|
||||
"smtp",
|
||||
"ssh",
|
||||
"stagehand",
|
||||
"stagehand_agent",
|
||||
"stripe",
|
||||
@@ -84,9 +102,11 @@
|
||||
"webflow",
|
||||
"whatsapp",
|
||||
"wikipedia",
|
||||
"wordpress",
|
||||
"x",
|
||||
"youtube",
|
||||
"zendesk",
|
||||
"zep"
|
||||
"zep",
|
||||
"zoom"
|
||||
]
|
||||
}
|
||||
|
||||
357
apps/docs/content/docs/en/tools/polymarket.mdx
Normal file
357
apps/docs/content/docs/en/tools/polymarket.mdx
Normal file
@@ -0,0 +1,357 @@
|
||||
---
|
||||
title: Polymarket
|
||||
description: Access prediction markets data from Polymarket
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="polymarket"
|
||||
color="#4C82FB"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Polymarket](https://polymarket.com) is a decentralized prediction markets platform where users can trade on the outcome of future events using blockchain technology. Polymarket provides a comprehensive API, enabling developers and agents to access live market data, event listings, price information, and orderbook statistics to power data-driven workflows and AI automations.
|
||||
|
||||
With Polymarket’s API and Sim integration, you can enable agents to programmatically retrieve prediction market information, explore open markets and associated events, analyze historical price data, and access orderbooks and market midpoints. This creates new possibilities for research, automated analysis, and developing intelligent agents that react to real-time event probabilities derived from market prices.
|
||||
|
||||
Key features of the Polymarket integration include:
|
||||
|
||||
- **Market Listing & Filtering:** List all current or historical prediction markets, filter by tag, sort, and paginate through results.
|
||||
- **Market Detail:** Retrieve details for a single market by market ID or slug, including its outcomes and status.
|
||||
- **Event Listings:** Access lists of Polymarket events and detailed event information.
|
||||
- **Orderbook & Price Data:** Analyze the orderbook, get the latest market prices, view the midpoint, or obtain historical price information for any market.
|
||||
- **Automation Ready:** Build agents or tools that react programmatically to market developments, changing odds, or specific event outcomes.
|
||||
|
||||
By using these documented API endpoints, you can seamlessly integrate Polymarket’s rich on-chain prediction market data into your own AI workflows, dashboards, research tools, and trading automations.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Polymarket prediction markets into the workflow. Can get markets, market, events, event, tags, series, orderbook, price, midpoint, price history, last trade price, spread, tick size, positions, trades, and search.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `polymarket_get_markets`
|
||||
|
||||
Retrieve a list of prediction markets from Polymarket with optional filtering
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `closed` | string | No | Filter by closed status \(true/false\). Use false for active markets only. |
|
||||
| `order` | string | No | Sort field \(e.g., id, volume, liquidity\) |
|
||||
| `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 \(recommended: 25-50\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Markets data and metadata |
|
||||
|
||||
### `polymarket_get_market`
|
||||
|
||||
Retrieve details of a specific prediction market by ID or slug
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `marketId` | string | No | The market ID. Required if slug is not provided. |
|
||||
| `slug` | string | No | The market slug \(e.g., "will-trump-win"\). Required if marketId is not provided. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Market data and metadata |
|
||||
|
||||
### `polymarket_get_events`
|
||||
|
||||
Retrieve a list of events from Polymarket with optional filtering
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `closed` | string | No | Filter by closed status \(true/false\). Use false for active events only. |
|
||||
| `order` | string | No | Sort field \(e.g., id, volume\) |
|
||||
| `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 \(recommended: 25-50\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Events data and metadata |
|
||||
|
||||
### `polymarket_get_event`
|
||||
|
||||
Retrieve details of a specific event by ID or slug
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `eventId` | string | No | The event ID. Required if slug is not provided. |
|
||||
| `slug` | string | No | The event slug \(e.g., "2024-presidential-election"\). Required if eventId is not provided. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Event data and metadata |
|
||||
|
||||
### `polymarket_get_tags`
|
||||
|
||||
Retrieve available tags for filtering markets from Polymarket
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | No | Number of results per page \(recommended: 25-50\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Tags data and metadata |
|
||||
|
||||
### `polymarket_search`
|
||||
|
||||
Search for markets, events, and profiles on Polymarket
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | Search query term |
|
||||
| `limit` | string | No | Number of results per page \(recommended: 25-50\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Search results and metadata |
|
||||
|
||||
### `polymarket_get_series`
|
||||
|
||||
Retrieve series (related market groups) from Polymarket
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `limit` | string | No | Number of results per page \(recommended: 25-50\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Series data and metadata |
|
||||
|
||||
### `polymarket_get_series_by_id`
|
||||
|
||||
Retrieve a specific series (related market group) by ID from Polymarket
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `seriesId` | string | Yes | The series ID |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Series data and metadata |
|
||||
|
||||
### `polymarket_get_orderbook`
|
||||
|
||||
Retrieve the order book summary for a specific token
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Orderbook data and metadata |
|
||||
|
||||
### `polymarket_get_price`
|
||||
|
||||
Retrieve the market price for a specific token and side
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
||||
| `side` | string | Yes | Order side: buy or sell |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Price data and metadata |
|
||||
|
||||
### `polymarket_get_midpoint`
|
||||
|
||||
Retrieve the midpoint price for a specific token
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Midpoint price data and metadata |
|
||||
|
||||
### `polymarket_get_price_history`
|
||||
|
||||
Retrieve historical price data for a specific market token
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
||||
| `interval` | string | No | Duration ending at current time \(1m, 1h, 6h, 1d, 1w, max\). Mutually exclusive with startTs/endTs. |
|
||||
| `fidelity` | number | No | Data resolution in minutes \(e.g., 60 for hourly\) |
|
||||
| `startTs` | number | No | Start timestamp \(Unix seconds UTC\) |
|
||||
| `endTs` | number | No | End timestamp \(Unix seconds UTC\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Price history data and metadata |
|
||||
|
||||
### `polymarket_get_last_trade_price`
|
||||
|
||||
Retrieve the last trade price for a specific token
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Last trade price and metadata |
|
||||
|
||||
### `polymarket_get_spread`
|
||||
|
||||
Retrieve the bid-ask spread for a specific token
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Spread data and metadata |
|
||||
|
||||
### `polymarket_get_tick_size`
|
||||
|
||||
Retrieve the minimum tick size for a specific token
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Tick size and metadata |
|
||||
|
||||
### `polymarket_get_positions`
|
||||
|
||||
Retrieve user positions from Polymarket
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `user` | string | Yes | User wallet address |
|
||||
| `market` | string | No | Optional market ID to filter positions |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Positions data and metadata |
|
||||
|
||||
### `polymarket_get_trades`
|
||||
|
||||
Retrieve trade history from Polymarket
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `user` | string | No | User wallet address to filter trades |
|
||||
| `market` | string | No | Market ID to filter trades |
|
||||
| `limit` | string | No | Number of results per page \(recommended: 25-50\) |
|
||||
| `offset` | string | No | Pagination offset \(skip this many results\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `output` | object | Trades data and metadata |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `polymarket`
|
||||
@@ -89,6 +89,13 @@ Create a new issue with specified properties
|
||||
| `bodyHtml` | string | Yes | Issue body in HTML format |
|
||||
| `accountId` | string | No | Account ID to associate with issue |
|
||||
| `assigneeId` | string | No | User ID to assign issue to |
|
||||
| `teamId` | string | No | Team ID to assign issue to |
|
||||
| `requesterId` | string | No | Requester user ID \(alternative to requester_email\) |
|
||||
| `requesterEmail` | string | No | Requester email address \(alternative to requester_id\) |
|
||||
| `priority` | string | No | Issue priority |
|
||||
| `tags` | string | No | Comma-separated tag IDs |
|
||||
| `customFields` | string | No | Custom fields as JSON object |
|
||||
| `attachmentUrls` | string | No | Comma-separated attachment URLs |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -130,6 +137,9 @@ Update an existing issue
|
||||
| `teamId` | string | No | Team ID to assign issue to |
|
||||
| `tags` | string | No | Comma-separated tag IDs |
|
||||
| `customFields` | string | No | Custom fields as JSON object |
|
||||
| `customerPortalVisible` | boolean | No | Whether issue is visible in customer portal |
|
||||
| `requesterId` | string | No | Requester user ID |
|
||||
| `accountId` | string | No | Account ID to associate with issue |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
173
apps/docs/content/docs/en/tools/rds.mdx
Normal file
173
apps/docs/content/docs/en/tools/rds.mdx
Normal file
@@ -0,0 +1,173 @@
|
||||
---
|
||||
title: Amazon RDS
|
||||
description: Connect to Amazon RDS via Data API
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="rds"
|
||||
color="linear-gradient(45deg, #2E27AD 0%, #527FFF 100%)"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Amazon RDS Aurora Serverless](https://aws.amazon.com/rds/aurora/serverless/) is a fully managed relational database that automatically starts up, shuts down, and scales capacity based on your application's needs. It allows you to run SQL databases in the cloud without managing database servers.
|
||||
|
||||
With RDS Aurora Serverless, you can:
|
||||
|
||||
- **Query data**: Run flexible SQL queries across your tables
|
||||
- **Insert new records**: Add data to your database automatically
|
||||
- **Update existing records**: Modify data in your tables using custom filters
|
||||
- **Delete records**: Remove unwanted data using precise criteria
|
||||
- **Execute raw SQL**: Run any valid SQL command supported by Aurora
|
||||
|
||||
In Sim, the RDS integration enables your agents to work with Amazon Aurora Serverless databases securely and programmatically. Supported operations include:
|
||||
|
||||
- **Query**: Run SELECT and other SQL queries to fetch rows from your database
|
||||
- **Insert**: Insert new records into tables with structured data
|
||||
- **Update**: Change data in rows that match your specified conditions
|
||||
- **Delete**: Remove records from a table by custom filters or criteria
|
||||
- **Execute**: Run raw SQL for advanced scenarios
|
||||
|
||||
This integration allows your agents to automate a wide range of database operations without manual intervention. By connecting Sim with Amazon RDS, you can build agents that manage, update, and retrieve relational data within your workflows—all without handling database infrastructure or connections.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Amazon RDS Aurora Serverless into the workflow using the Data API. Can query, insert, update, delete, and execute raw SQL without managing database connections.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `rds_query`
|
||||
|
||||
Execute a SELECT query on Amazon RDS using the Data API
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
|
||||
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
||||
| `database` | string | No | Database name \(optional\) |
|
||||
| `query` | string | Yes | SQL SELECT query to execute |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `rows` | array | Array of rows returned from the query |
|
||||
| `rowCount` | number | Number of rows returned |
|
||||
|
||||
### `rds_insert`
|
||||
|
||||
Insert data into an Amazon RDS table using the Data API
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
|
||||
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
||||
| `database` | string | No | Database name \(optional\) |
|
||||
| `table` | string | Yes | Table name to insert into |
|
||||
| `data` | object | Yes | Data to insert as key-value pairs |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `rows` | array | Array of inserted rows |
|
||||
| `rowCount` | number | Number of rows inserted |
|
||||
|
||||
### `rds_update`
|
||||
|
||||
Update data in an Amazon RDS table using the Data API
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
|
||||
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
||||
| `database` | string | No | Database name \(optional\) |
|
||||
| `table` | string | Yes | Table name to update |
|
||||
| `data` | object | Yes | Data to update as key-value pairs |
|
||||
| `conditions` | object | Yes | Conditions for the update \(e.g., \{"id": 1\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `rows` | array | Array of updated rows |
|
||||
| `rowCount` | number | Number of rows updated |
|
||||
|
||||
### `rds_delete`
|
||||
|
||||
Delete data from an Amazon RDS table using the Data API
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
|
||||
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
||||
| `database` | string | No | Database name \(optional\) |
|
||||
| `table` | string | Yes | Table name to delete from |
|
||||
| `conditions` | object | Yes | Conditions for the delete \(e.g., \{"id": 1\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `rows` | array | Array of deleted rows |
|
||||
| `rowCount` | number | Number of rows deleted |
|
||||
|
||||
### `rds_execute`
|
||||
|
||||
Execute raw SQL on Amazon RDS using the Data API
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Yes | AWS region \(e.g., us-east-1\) |
|
||||
| `accessKeyId` | string | Yes | AWS access key ID |
|
||||
| `secretAccessKey` | string | Yes | AWS secret access key |
|
||||
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
|
||||
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
|
||||
| `database` | string | No | Database name \(optional\) |
|
||||
| `query` | string | Yes | Raw SQL query to execute |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Operation status message |
|
||||
| `rows` | array | Array of rows returned or affected |
|
||||
| `rowCount` | number | Number of rows affected |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `rds`
|
||||
@@ -7,7 +7,7 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="s3"
|
||||
color="#E0E0E0"
|
||||
color="linear-gradient(45deg, #1B660F 0%, #6CAE3E 100%)"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
|
||||
59
apps/docs/content/docs/en/tools/search.mdx
Normal file
59
apps/docs/content/docs/en/tools/search.mdx
Normal file
@@ -0,0 +1,59 @@
|
||||
---
|
||||
title: Search
|
||||
description: Search the web ($0.01 per search)
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="search"
|
||||
color="#3B82F6"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
The **Search** tool lets you search the web from within your Sim workflows using state-of-the-art search engines. Use it to pull in the latest information, news, facts, and web content directly into your agents, automations, or conversations.
|
||||
|
||||
- **General web search**: Find up-to-date information from the internet to supplement your workflows.
|
||||
- **Automated queries**: Let agents or program logic submit search queries and handle the results automatically.
|
||||
- **Structured results**: Returns the most relevant web results, including title, link, snippet, and date for each result.
|
||||
|
||||
> **Note:** Each search costs **$0.01** per query.
|
||||
|
||||
This tool is ideal for any workflow where your agents need access to live web data or must reference current events, perform research, or fetch supplemental content.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Search the web using the Search tool. Each search costs $0.01 per query.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `search_tool`
|
||||
|
||||
Search the web. Returns the most relevant web results, including title, link, snippet, and date for each result.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | The search query |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | json | Search results |
|
||||
| `query` | string | The search query |
|
||||
| `totalResults` | number | Total number of results |
|
||||
| `source` | string | Search source \(exa\) |
|
||||
| `cost` | json | Cost information \($0.01\) |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `search`
|
||||
396
apps/docs/content/docs/en/tools/sendgrid.mdx
Normal file
396
apps/docs/content/docs/en/tools/sendgrid.mdx
Normal file
@@ -0,0 +1,396 @@
|
||||
---
|
||||
title: SendGrid
|
||||
description: Send emails and manage contacts, lists, and templates with SendGrid
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="sendgrid"
|
||||
color="#1A82E2"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[SendGrid](https://sendgrid.com) is a leading cloud-based email delivery platform trusted by developers and businesses to send reliable transactional and marketing emails at scale. With its robust APIs and powerful tools, SendGrid enables you to manage all aspects of your email communication, from sending notifications and receipts to managing complex marketing campaigns.
|
||||
|
||||
SendGrid empowers users with a full suite of email operations, allowing you to automate critical email workflows and closely manage contact lists, templates, and recipient engagement. Its seamless integration with Sim enables agents and workflows to deliver targeted messages, maintain dynamic contact and recipient lists, trigger personalized emails through templates, and track the results in real time.
|
||||
|
||||
Key features of SendGrid include:
|
||||
|
||||
- **Transactional Email:** Send automated and high-volume transactional emails (like notifications, receipts, and password resets).
|
||||
- **Dynamic Templates:** Use rich HTML or text templates with dynamic data for highly personalized communication at scale.
|
||||
- **Contact Management:** Add and update marketing contacts, manage recipient lists, and target segments for campaigns.
|
||||
- **Attachments Support:** Include one or more file attachments in your emails.
|
||||
- **Comprehensive API Coverage:** Programmatically manage emails, contacts, lists, templates, suppression groups, and more.
|
||||
|
||||
By connecting SendGrid with Sim, your agents can:
|
||||
|
||||
- Send both simple and advanced (templated or multi-recipient) emails as part of any workflow.
|
||||
- Manage and segment contacts and lists automatically.
|
||||
- Leverage templates for consistency and dynamic personalization.
|
||||
- Track and respond to email engagement within your automated processes.
|
||||
|
||||
This integration allows you to automate all critical communication flows, ensure messages reach the right audience, and maintain control over your organization’s email strategy, directly from Sim workflows.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate SendGrid into your workflow. Send transactional emails, manage marketing contacts and lists, and work with email templates. Supports dynamic templates, attachments, and comprehensive contact management.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `sendgrid_send_mail`
|
||||
|
||||
Send an email using SendGrid API
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `from` | string | Yes | Sender email address \(must be verified in SendGrid\) |
|
||||
| `fromName` | string | No | Sender name |
|
||||
| `to` | string | Yes | Recipient email address |
|
||||
| `toName` | string | No | Recipient name |
|
||||
| `subject` | string | No | Email subject \(required unless using a template with pre-defined subject\) |
|
||||
| `content` | string | No | Email body content \(required unless using a template with pre-defined content\) |
|
||||
| `contentType` | string | No | Content type \(text/plain or text/html\) |
|
||||
| `cc` | string | No | CC email address |
|
||||
| `bcc` | string | No | BCC email address |
|
||||
| `replyTo` | string | No | Reply-to email address |
|
||||
| `replyToName` | string | No | Reply-to name |
|
||||
| `attachments` | file[] | No | Files to attach to the email |
|
||||
| `templateId` | string | No | SendGrid template ID to use |
|
||||
| `dynamicTemplateData` | json | No | JSON object of dynamic template data |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the email was sent successfully |
|
||||
| `messageId` | string | SendGrid message ID |
|
||||
| `to` | string | Recipient email address |
|
||||
| `subject` | string | Email subject |
|
||||
|
||||
### `sendgrid_add_contact`
|
||||
|
||||
Add a new contact to SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `email` | string | Yes | Contact email address |
|
||||
| `firstName` | string | No | Contact first name |
|
||||
| `lastName` | string | No | Contact last name |
|
||||
| `customFields` | json | No | JSON object of custom field key-value pairs \(use field IDs like e1_T, e2_N, e3_D, not field names\) |
|
||||
| `listIds` | string | No | Comma-separated list IDs to add the contact to |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobId` | string | Job ID for tracking the async contact creation |
|
||||
| `email` | string | Contact email address |
|
||||
| `firstName` | string | Contact first name |
|
||||
| `lastName` | string | Contact last name |
|
||||
| `message` | string | Status message |
|
||||
|
||||
### `sendgrid_get_contact`
|
||||
|
||||
Get a specific contact by ID from SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `contactId` | string | Yes | Contact ID |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Contact ID |
|
||||
| `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 |
|
||||
|
||||
### `sendgrid_search_contacts`
|
||||
|
||||
Search for contacts in SendGrid using a query
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `query` | string | Yes | Search query \(e.g., \"email LIKE '%example.com%' AND CONTAINS\(list_ids, 'list-id'\)\"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contacts` | json | Array of matching contacts |
|
||||
| `contactCount` | number | Total number of contacts found |
|
||||
|
||||
### `sendgrid_delete_contacts`
|
||||
|
||||
Delete one or more contacts from SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `contactIds` | string | Yes | Comma-separated contact IDs to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobId` | string | Job ID for the deletion request |
|
||||
|
||||
### `sendgrid_create_list`
|
||||
|
||||
Create a new contact list in SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `name` | string | Yes | List name |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | List ID |
|
||||
| `name` | string | List name |
|
||||
| `contactCount` | number | Number of contacts in the list |
|
||||
|
||||
### `sendgrid_get_list`
|
||||
|
||||
Get a specific list by ID from SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `listId` | string | Yes | List ID |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | List ID |
|
||||
| `name` | string | List name |
|
||||
| `contactCount` | number | Number of contacts in the list |
|
||||
|
||||
### `sendgrid_list_all_lists`
|
||||
|
||||
Get all contact lists from SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `pageSize` | number | No | Number of lists to return per page \(default: 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `lists` | json | Array of lists |
|
||||
|
||||
### `sendgrid_delete_list`
|
||||
|
||||
Delete a contact list from SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `listId` | string | Yes | List ID to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Success message |
|
||||
|
||||
### `sendgrid_add_contacts_to_list`
|
||||
|
||||
Add or update contacts and assign them to a list in SendGrid (uses PUT /v3/marketing/contacts)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `listId` | string | Yes | List ID to add contacts to |
|
||||
| `contacts` | json | Yes | JSON array of contact objects. Each contact must have at least: email \(or phone_number_id/external_id/anonymous_id\). Example: \[\{"email": "user@example.com", "first_name": "John"\}\] |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobId` | string | Job ID for tracking the async operation |
|
||||
| `message` | string | Status message |
|
||||
|
||||
### `sendgrid_remove_contacts_from_list`
|
||||
|
||||
Remove contacts from a specific list in SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `listId` | string | Yes | List ID |
|
||||
| `contactIds` | string | Yes | Comma-separated contact IDs to remove from the list |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobId` | string | Job ID for the request |
|
||||
|
||||
### `sendgrid_create_template`
|
||||
|
||||
Create a new email template in SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `name` | string | Yes | Template name |
|
||||
| `generation` | string | No | Template generation type \(legacy or dynamic, default: dynamic\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Template ID |
|
||||
| `name` | string | Template name |
|
||||
| `generation` | string | Template generation |
|
||||
| `updatedAt` | string | Last update timestamp |
|
||||
| `versions` | json | Array of template versions |
|
||||
|
||||
### `sendgrid_get_template`
|
||||
|
||||
Get a specific template by ID from SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `templateId` | string | Yes | Template ID |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Template ID |
|
||||
| `name` | string | Template name |
|
||||
| `generation` | string | Template generation |
|
||||
| `updatedAt` | string | Last update timestamp |
|
||||
| `versions` | json | Array of template versions |
|
||||
|
||||
### `sendgrid_list_templates`
|
||||
|
||||
Get all email templates from SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `generations` | string | No | Filter by generation \(legacy, dynamic, or both\) |
|
||||
| `pageSize` | number | No | Number of templates to return per page \(default: 20\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `templates` | json | Array of templates |
|
||||
|
||||
### `sendgrid_delete_template`
|
||||
|
||||
Delete an email template from SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `templateId` | string | Yes | Template ID to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Operation success status |
|
||||
| `messageId` | string | Email message ID \(send_mail\) |
|
||||
| `id` | string | Resource ID |
|
||||
| `jobId` | string | Job ID for async operations |
|
||||
| `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 |
|
||||
| `templates` | json | Array of templates |
|
||||
| `message` | string | Status or success message |
|
||||
| `name` | string | Resource name |
|
||||
| `generation` | string | Template generation |
|
||||
|
||||
### `sendgrid_create_template_version`
|
||||
|
||||
Create a new version of an email template in SendGrid
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Yes | SendGrid API key |
|
||||
| `templateId` | string | Yes | Template ID |
|
||||
| `name` | string | Yes | Version name |
|
||||
| `subject` | string | Yes | Email subject line |
|
||||
| `htmlContent` | string | No | HTML content of the template |
|
||||
| `plainContent` | string | No | Plain text content of the template |
|
||||
| `active` | boolean | No | Whether this version is active \(default: true\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Version ID |
|
||||
| `templateId` | string | Template ID |
|
||||
| `name` | string | Version name |
|
||||
| `subject` | string | Email subject |
|
||||
| `active` | boolean | Whether this version is active |
|
||||
| `htmlContent` | string | HTML content |
|
||||
| `plainContent` | string | Plain text content |
|
||||
| `updatedAt` | string | Last update timestamp |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `sendgrid`
|
||||
449
apps/docs/content/docs/en/tools/shopify.mdx
Normal file
449
apps/docs/content/docs/en/tools/shopify.mdx
Normal file
@@ -0,0 +1,449 @@
|
||||
---
|
||||
title: Shopify
|
||||
description: Manage products, orders, customers, and inventory in your Shopify store
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="shopify"
|
||||
color="#FFFFFF"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Shopify](https://www.shopify.com/) is a leading e-commerce platform designed to help merchants build, run, and grow their online stores. Shopify makes it easy to manage every aspect of your store, from products and inventory to orders and customers.
|
||||
|
||||
With Shopify in Sim, your agents can:
|
||||
|
||||
- **Create and manage products**: Add new products, update product details, and remove products from your store.
|
||||
- **List and retrieve orders**: Get information about customer orders, including filtering and order management.
|
||||
- **Manage customers**: Access and update customer details, or add new customers to your store.
|
||||
- **Adjust inventory levels**: Programmatically change product stock levels to keep your inventory accurate.
|
||||
|
||||
Use Sim's Shopify integration to automate common store management workflows—such as syncing inventory, fulfilling orders, or managing listings—directly from your automations. Empower your agents to access, update, and organize all your store data using simple, programmatic tools.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Shopify into your workflow. Manage products, orders, customers, and inventory. Create, read, update, and delete products. List and manage orders. Handle customer data and adjust inventory levels.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `shopify_create_product`
|
||||
|
||||
Create a new product in your Shopify store
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `title` | string | Yes | Product title |
|
||||
| `descriptionHtml` | string | No | Product description \(HTML\) |
|
||||
| `vendor` | string | No | Product vendor/brand |
|
||||
| `productType` | string | No | Product type/category |
|
||||
| `tags` | array | No | Product tags |
|
||||
| `status` | string | No | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `product` | object | The created product |
|
||||
|
||||
### `shopify_get_product`
|
||||
|
||||
Get a single product by ID from your Shopify store
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `productId` | string | Yes | Product ID \(gid://shopify/Product/123456789\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `product` | object | The product details |
|
||||
|
||||
### `shopify_list_products`
|
||||
|
||||
List products from your Shopify store with optional filtering
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `first` | number | No | Number of products to return \(default: 50, max: 250\) |
|
||||
| `query` | string | No | Search query to filter products \(e.g., "title:shirt" or "vendor:Nike" or "status:active"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `products` | array | List of products |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
|
||||
### `shopify_update_product`
|
||||
|
||||
Update an existing product in your Shopify store
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `productId` | string | Yes | Product ID to update \(gid://shopify/Product/123456789\) |
|
||||
| `title` | string | No | New product title |
|
||||
| `descriptionHtml` | string | No | New product description \(HTML\) |
|
||||
| `vendor` | string | No | New product vendor/brand |
|
||||
| `productType` | string | No | New product type/category |
|
||||
| `tags` | array | No | New product tags |
|
||||
| `status` | string | No | New product status \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `product` | object | The updated product |
|
||||
|
||||
### `shopify_delete_product`
|
||||
|
||||
Delete a product from your Shopify store
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `productId` | string | Yes | Product ID to delete \(gid://shopify/Product/123456789\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deletedId` | string | The ID of the deleted product |
|
||||
|
||||
### `shopify_get_order`
|
||||
|
||||
Get a single order by ID from your Shopify store
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `orderId` | string | Yes | Order ID \(gid://shopify/Order/123456789\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | The order details |
|
||||
|
||||
### `shopify_list_orders`
|
||||
|
||||
List orders from your Shopify store with optional filtering
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `first` | number | No | Number of orders to return \(default: 50, max: 250\) |
|
||||
| `status` | string | No | Filter by order status \(open, closed, cancelled, any\) |
|
||||
| `query` | string | No | Search query to filter orders \(e.g., "financial_status:paid" or "fulfillment_status:unfulfilled" or "email:customer@example.com"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orders` | array | List of orders |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
|
||||
### `shopify_update_order`
|
||||
|
||||
Update an existing order in your Shopify store (note, tags, email)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `orderId` | string | Yes | Order ID to update \(gid://shopify/Order/123456789\) |
|
||||
| `note` | string | No | New order note |
|
||||
| `tags` | array | No | New order tags |
|
||||
| `email` | string | No | New customer email for the order |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | The updated order |
|
||||
|
||||
### `shopify_cancel_order`
|
||||
|
||||
Cancel an order in your Shopify store
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `orderId` | string | Yes | Order ID to cancel \(gid://shopify/Order/123456789\) |
|
||||
| `reason` | string | Yes | Cancellation reason \(CUSTOMER, DECLINED, FRAUD, INVENTORY, STAFF, OTHER\) |
|
||||
| `notifyCustomer` | boolean | No | Whether to notify the customer about the cancellation |
|
||||
| `refund` | boolean | No | Whether to refund the order |
|
||||
| `restock` | boolean | No | Whether to restock the inventory |
|
||||
| `staffNote` | string | No | A note about the cancellation for staff reference |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | The cancellation result |
|
||||
|
||||
### `shopify_create_customer`
|
||||
|
||||
Create a new customer in your Shopify store
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `email` | string | No | Customer email address |
|
||||
| `firstName` | string | No | Customer first name |
|
||||
| `lastName` | string | No | Customer last name |
|
||||
| `phone` | string | No | Customer phone number |
|
||||
| `note` | string | No | Note about the customer |
|
||||
| `tags` | array | No | Customer tags |
|
||||
| `addresses` | array | No | Customer addresses |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | The created customer |
|
||||
|
||||
### `shopify_get_customer`
|
||||
|
||||
Get a single customer by ID from your Shopify store
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `customerId` | string | Yes | Customer ID \(gid://shopify/Customer/123456789\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | The customer details |
|
||||
|
||||
### `shopify_list_customers`
|
||||
|
||||
List customers from your Shopify store with optional filtering
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `first` | number | No | Number of customers to return \(default: 50, max: 250\) |
|
||||
| `query` | string | No | Search query to filter customers \(e.g., "first_name:John" or "last_name:Smith" or "email:*@gmail.com" or "tag:vip"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customers` | array | List of customers |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
|
||||
### `shopify_update_customer`
|
||||
|
||||
Update an existing customer in your Shopify store
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `customerId` | string | Yes | Customer ID to update \(gid://shopify/Customer/123456789\) |
|
||||
| `email` | string | No | New customer email address |
|
||||
| `firstName` | string | No | New customer first name |
|
||||
| `lastName` | string | No | New customer last name |
|
||||
| `phone` | string | No | New customer phone number |
|
||||
| `note` | string | No | New note about the customer |
|
||||
| `tags` | array | No | New customer tags |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | The updated customer |
|
||||
|
||||
### `shopify_delete_customer`
|
||||
|
||||
Delete a customer from your Shopify store
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `customerId` | string | Yes | Customer ID to delete \(gid://shopify/Customer/123456789\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deletedId` | string | The ID of the deleted customer |
|
||||
|
||||
### `shopify_list_inventory_items`
|
||||
|
||||
List inventory items from your Shopify store. Use this to find inventory item IDs by SKU.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `first` | number | No | Number of inventory items to return \(default: 50, max: 250\) |
|
||||
| `query` | string | No | Search query to filter inventory items \(e.g., "sku:ABC123"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `inventoryItems` | array | List of inventory items with their IDs, SKUs, and stock levels |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
|
||||
### `shopify_get_inventory_level`
|
||||
|
||||
Get inventory level for a product variant at a specific location
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `inventoryItemId` | string | Yes | Inventory item ID \(gid://shopify/InventoryItem/123456789\) |
|
||||
| `locationId` | string | No | Location ID to filter by \(optional\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `inventoryLevel` | object | The inventory level details |
|
||||
|
||||
### `shopify_adjust_inventory`
|
||||
|
||||
Adjust inventory quantity for a product variant at a specific location
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `inventoryItemId` | string | Yes | Inventory item ID \(gid://shopify/InventoryItem/123456789\) |
|
||||
| `locationId` | string | Yes | Location ID \(gid://shopify/Location/123456789\) |
|
||||
| `delta` | number | Yes | Amount to adjust \(positive to increase, negative to decrease\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `inventoryLevel` | object | The inventory adjustment result |
|
||||
|
||||
### `shopify_list_locations`
|
||||
|
||||
List inventory locations from your Shopify store. Use this to find location IDs needed for inventory operations.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `first` | number | No | Number of locations to return \(default: 50, max: 250\) |
|
||||
| `includeInactive` | boolean | No | Whether to include deactivated locations \(default: false\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `locations` | array | List of locations with their IDs, names, and addresses |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
|
||||
### `shopify_create_fulfillment`
|
||||
|
||||
Create a fulfillment to mark order items as shipped. Requires a fulfillment order ID (get this from the order details).
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `fulfillmentOrderId` | string | Yes | The fulfillment order ID \(e.g., gid://shopify/FulfillmentOrder/123456789\) |
|
||||
| `trackingNumber` | string | No | Tracking number for the shipment |
|
||||
| `trackingCompany` | string | No | Shipping carrier name \(e.g., UPS, FedEx, USPS, DHL\) |
|
||||
| `trackingUrl` | string | No | URL to track the shipment |
|
||||
| `notifyCustomer` | boolean | No | Whether to send a shipping confirmation email to the customer \(default: true\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `fulfillment` | object | The created fulfillment with tracking info and fulfilled items |
|
||||
|
||||
### `shopify_list_collections`
|
||||
|
||||
List product collections from your Shopify store. Filter by title, type (custom/smart), or handle.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `first` | number | No | Number of collections to return \(default: 50, max: 250\) |
|
||||
| `query` | string | No | Search query to filter collections \(e.g., "title:Summer" or "collection_type:smart"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `collections` | array | List of collections with their IDs, titles, and product counts |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
|
||||
### `shopify_get_collection`
|
||||
|
||||
Get a specific collection by ID, including its products. Use this to retrieve products within a collection.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Yes | Your Shopify store domain \(e.g., mystore.myshopify.com\) |
|
||||
| `collectionId` | string | Yes | The collection ID \(e.g., gid://shopify/Collection/123456789\) |
|
||||
| `productsFirst` | number | No | Number of products to return from this collection \(default: 50, max: 250\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `collection` | object | The collection details including its products |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `shopify`
|
||||
@@ -122,6 +122,82 @@ Read the latest messages from Slack channels. Retrieve conversation history with
|
||||
| --------- | ---- | ----------- |
|
||||
| `messages` | array | Array of message objects from the channel |
|
||||
|
||||
### `slack_list_channels`
|
||||
|
||||
List all channels in a Slack workspace. Returns public and private channels the bot has access to.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `authMethod` | string | No | Authentication method: oauth or bot_token |
|
||||
| `botToken` | string | No | Bot token for Custom Bot |
|
||||
| `includePrivate` | boolean | No | Include private channels the bot is a member of \(default: true\) |
|
||||
| `excludeArchived` | boolean | No | Exclude archived channels \(default: true\) |
|
||||
| `limit` | number | No | Maximum number of channels to return \(default: 100, max: 200\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `channels` | array | Array of channel objects from the workspace |
|
||||
|
||||
### `slack_list_members`
|
||||
|
||||
List all members (user IDs) in a Slack channel. Use with Get User Info to resolve IDs to names.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `authMethod` | string | No | Authentication method: oauth or bot_token |
|
||||
| `botToken` | string | No | Bot token for Custom Bot |
|
||||
| `channel` | string | Yes | Channel ID to list members from |
|
||||
| `limit` | number | No | Maximum number of members to return \(default: 100, max: 200\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `members` | array | Array of user IDs who are members of the channel \(e.g., U1234567890\) |
|
||||
|
||||
### `slack_list_users`
|
||||
|
||||
List all users in a Slack workspace. Returns user profiles with names and avatars.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `authMethod` | string | No | Authentication method: oauth or bot_token |
|
||||
| `botToken` | string | No | Bot token for Custom Bot |
|
||||
| `includeDeleted` | boolean | No | Include deactivated/deleted users \(default: false\) |
|
||||
| `limit` | number | No | Maximum number of users to return \(default: 100, max: 200\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Array of user objects from the workspace |
|
||||
|
||||
### `slack_get_user`
|
||||
|
||||
Get detailed information about a specific Slack user by their user ID.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `authMethod` | string | No | Authentication method: oauth or bot_token |
|
||||
| `botToken` | string | No | Bot token for Custom Bot |
|
||||
| `userId` | string | Yes | User ID to look up \(e.g., U1234567890\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | Detailed user information |
|
||||
|
||||
### `slack_download`
|
||||
|
||||
Download a file from Slack
|
||||
|
||||
78
apps/docs/content/docs/en/tools/smtp.mdx
Normal file
78
apps/docs/content/docs/en/tools/smtp.mdx
Normal file
@@ -0,0 +1,78 @@
|
||||
---
|
||||
title: SMTP
|
||||
description: Send emails via any SMTP mail server
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="smtp"
|
||||
color="#4A5568"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[SMTP (Simple Mail Transfer Protocol)](https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol) is the foundational standard for email transmission across the Internet. By connecting to any SMTP-compatible server—such as Gmail, Outlook, or your organization's own mail infrastructure—you can send emails programmatically and automate your outbound communications.
|
||||
|
||||
SMTP integration allows you to fully customize email sending through direct server connectivity, supporting both basic and advanced email use cases. With SMTP, you can control every aspect of message delivery, recipient management, and content formatting, making it suitable for transactional notifications, bulk mailings, and any automated workflow requiring robust outbound email delivery.
|
||||
|
||||
**Key features available via SMTP integration include:**
|
||||
|
||||
- **Universal Email Delivery:** Send emails using any SMTP server by configuring standard server connection parameters.
|
||||
- **Customizable Sender and Recipients:** Specify sender address, display name, primary recipients, as well as CC and BCC fields.
|
||||
- **Rich Content Support:** Send plain text or richly formatted HTML emails according to your requirements.
|
||||
- **Attachments:** Include multiple files as attachments in outgoing emails.
|
||||
- **Flexible Security:** Connect using TLS, SSL, or standard (unencrypted) protocols as supported by your SMTP provider.
|
||||
- **Advanced Headers:** Set reply-to headers and other advanced email options to cater for complex mailflows and user interactions.
|
||||
|
||||
By integrating SMTP with Sim, agents and workflows can programmatically send emails as part of any automated process—ranging from sending notifications and confirmations, to automating external communications, reporting, and document delivery. This offers a highly flexible, provider-agnostic approach to managing email directly within your AI-driven processes.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Send emails using any SMTP server (Gmail, Outlook, custom servers, etc.). Configure SMTP connection settings and send emails with full control over content, recipients, and attachments.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `smtp_send_mail`
|
||||
|
||||
Send emails via SMTP server
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `smtpHost` | string | Yes | SMTP server hostname \(e.g., smtp.gmail.com\) |
|
||||
| `smtpPort` | number | Yes | SMTP server port \(587 for TLS, 465 for SSL\) |
|
||||
| `smtpUsername` | string | Yes | SMTP authentication username |
|
||||
| `smtpPassword` | string | Yes | SMTP authentication password |
|
||||
| `smtpSecure` | string | Yes | Security protocol \(TLS, SSL, or None\) |
|
||||
| `from` | string | Yes | Sender email address |
|
||||
| `to` | string | Yes | Recipient email address |
|
||||
| `subject` | string | Yes | Email subject |
|
||||
| `body` | string | Yes | Email body content |
|
||||
| `contentType` | string | No | Content type \(text or html\) |
|
||||
| `fromName` | string | No | Display name for sender |
|
||||
| `cc` | string | No | CC recipients \(comma-separated\) |
|
||||
| `bcc` | string | No | BCC recipients \(comma-separated\) |
|
||||
| `replyTo` | string | No | Reply-to email address |
|
||||
| `attachments` | file[] | No | Files to attach to the email |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the email was sent successfully |
|
||||
| `messageId` | string | Message ID from SMTP server |
|
||||
| `to` | string | Recipient email address |
|
||||
| `subject` | string | Email subject |
|
||||
| `error` | string | Error message if sending failed |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `smtp`
|
||||
399
apps/docs/content/docs/en/tools/ssh.mdx
Normal file
399
apps/docs/content/docs/en/tools/ssh.mdx
Normal file
@@ -0,0 +1,399 @@
|
||||
---
|
||||
title: SSH
|
||||
description: Connect to remote servers via SSH
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="ssh"
|
||||
color="#000000"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[SSH (Secure Shell)](https://en.wikipedia.org/wiki/Secure_Shell) is a widely-used protocol for securely connecting to remote servers, allowing you to execute commands, transfer files, and manage systems over encrypted channels.
|
||||
|
||||
With SSH support in Sim, your agents can:
|
||||
|
||||
- **Execute remote commands**: Run shell commands on any SSH-accessible server
|
||||
- **Upload and run scripts**: Easily transfer and execute multi-line scripts for advanced automation
|
||||
- **Transfer files securely**: Upload and download files as part of your workflows (coming soon or via command)
|
||||
- **Automate server management**: Perform updates, maintenance, monitoring, deployments, and configuration tasks programmatically
|
||||
- **Use flexible authentication**: Connect with password or private key authentication, including support for encrypted keys
|
||||
|
||||
The following Sim SSH tools enable your agents to interact with servers as part of larger automations:
|
||||
|
||||
- `ssh_execute_command`: Run any single shell command remotely and capture output, status, and errors.
|
||||
- `ssh_execute_script`: Upload and execute a full multi-line script on the remote system.
|
||||
- (Additional tools coming soon, such as file transfer.)
|
||||
|
||||
By integrating SSH into your agent workflows, you can automate secure access, remote operations, and server orchestration—streamlining DevOps, IT automation, and custom remote management, all from within Sim.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Execute commands, transfer files, and manage remote servers via SSH. Supports password and private key authentication for secure server access.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `ssh_execute_command`
|
||||
|
||||
Execute a shell command on a remote SSH server
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
| `command` | string | Yes | Shell command to execute on the remote server |
|
||||
| `workingDirectory` | string | No | Working directory for command execution |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `stdout` | string | Standard output from command |
|
||||
| `stderr` | string | Standard error output |
|
||||
| `exitCode` | number | Command exit code |
|
||||
| `success` | boolean | Whether command succeeded \(exit code 0\) |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
### `ssh_execute_script`
|
||||
|
||||
Upload and execute a multi-line script on a remote SSH server
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
| `script` | string | Yes | Script content to execute \(bash, python, etc.\) |
|
||||
| `interpreter` | string | No | Script interpreter \(default: /bin/bash\) |
|
||||
| `workingDirectory` | string | No | Working directory for script execution |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `stdout` | string | Standard output from script |
|
||||
| `stderr` | string | Standard error output |
|
||||
| `exitCode` | number | Script exit code |
|
||||
| `success` | boolean | Whether script succeeded \(exit code 0\) |
|
||||
| `scriptPath` | string | Temporary path where script was uploaded |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
### `ssh_check_command_exists`
|
||||
|
||||
Check if a command/program exists on the remote SSH server
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
| `commandName` | string | Yes | Command name to check \(e.g., docker, git, python3\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `commandExists` | boolean | Whether the command exists |
|
||||
| `commandPath` | string | Full path to the command \(if found\) |
|
||||
| `version` | string | Command version output \(if applicable\) |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
### `ssh_upload_file`
|
||||
|
||||
Upload a file to a remote SSH server
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
| `fileContent` | string | Yes | File content to upload \(base64 encoded for binary files\) |
|
||||
| `fileName` | string | Yes | Name of the file being uploaded |
|
||||
| `remotePath` | string | Yes | Destination path on the remote server |
|
||||
| `permissions` | string | No | File permissions \(e.g., 0644\) |
|
||||
| `overwrite` | boolean | No | Whether to overwrite existing files \(default: true\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `uploaded` | boolean | Whether the file was uploaded successfully |
|
||||
| `remotePath` | string | Final path on the remote server |
|
||||
| `size` | number | File size in bytes |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
### `ssh_download_file`
|
||||
|
||||
Download a file from a remote SSH server
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
| `remotePath` | string | Yes | Path of the file on the remote server |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `downloaded` | boolean | Whether the file was downloaded successfully |
|
||||
| `fileContent` | string | File content \(base64 encoded for binary files\) |
|
||||
| `fileName` | string | Name of the downloaded file |
|
||||
| `remotePath` | string | Source path on the remote server |
|
||||
| `size` | number | File size in bytes |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
### `ssh_list_directory`
|
||||
|
||||
List files and directories in a remote directory
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
| `path` | string | Yes | Remote directory path to list |
|
||||
| `detailed` | boolean | No | Include file details \(size, permissions, modified date\) |
|
||||
| `recursive` | boolean | No | List subdirectories recursively \(default: false\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `entries` | array | Array of file and directory entries |
|
||||
|
||||
### `ssh_check_file_exists`
|
||||
|
||||
Check if a file or directory exists on the remote SSH server
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
| `path` | string | Yes | Remote file or directory path to check |
|
||||
| `type` | string | No | Expected type: file, directory, or any \(default: any\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `exists` | boolean | Whether the path exists |
|
||||
| `type` | string | Type of path \(file, directory, symlink, not_found\) |
|
||||
| `size` | number | File size if it is a file |
|
||||
| `permissions` | string | File permissions \(e.g., 0755\) |
|
||||
| `modified` | string | Last modified timestamp |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
### `ssh_create_directory`
|
||||
|
||||
Create a directory on the remote SSH server
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
| `path` | string | Yes | Directory path to create |
|
||||
| `recursive` | boolean | No | Create parent directories if they do not exist \(default: true\) |
|
||||
| `permissions` | string | No | Directory permissions \(default: 0755\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `created` | boolean | Whether the directory was created successfully |
|
||||
| `remotePath` | string | Created directory path |
|
||||
| `alreadyExists` | boolean | Whether the directory already existed |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
### `ssh_delete_file`
|
||||
|
||||
Delete a file or directory from the remote SSH server
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
| `path` | string | Yes | Path to delete |
|
||||
| `recursive` | boolean | No | Recursively delete directories \(default: false\) |
|
||||
| `force` | boolean | No | Force deletion without confirmation \(default: false\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Whether the path was deleted successfully |
|
||||
| `remotePath` | string | Deleted path |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
### `ssh_move_rename`
|
||||
|
||||
Move or rename a file or directory on the remote SSH server
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
| `sourcePath` | string | Yes | Current path of the file or directory |
|
||||
| `destinationPath` | string | Yes | New path for the file or directory |
|
||||
| `overwrite` | boolean | No | Overwrite destination if it exists \(default: false\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `moved` | boolean | Whether the operation was successful |
|
||||
| `sourcePath` | string | Original path |
|
||||
| `destinationPath` | string | New path |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
### `ssh_get_system_info`
|
||||
|
||||
Retrieve system information from the remote SSH server
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `hostname` | string | Server hostname |
|
||||
| `os` | string | Operating system \(e.g., Linux, Darwin\) |
|
||||
| `architecture` | string | CPU architecture \(e.g., x64, arm64\) |
|
||||
| `uptime` | number | System uptime in seconds |
|
||||
| `memory` | json | Memory information \(total, free, used\) |
|
||||
| `diskSpace` | json | Disk space information \(total, free, used\) |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
### `ssh_read_file_content`
|
||||
|
||||
Read the contents of a remote file
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
| `path` | string | Yes | Remote file path to read |
|
||||
| `encoding` | string | No | File encoding \(default: utf-8\) |
|
||||
| `maxSize` | number | No | Maximum file size to read in MB \(default: 10\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | File content as string |
|
||||
| `size` | number | File size in bytes |
|
||||
| `lines` | number | Number of lines in file |
|
||||
| `remotePath` | string | Remote file path |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
### `ssh_write_file_content`
|
||||
|
||||
Write or append content to a remote file
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Yes | SSH server hostname or IP address |
|
||||
| `port` | number | Yes | SSH server port \(default: 22\) |
|
||||
| `username` | string | Yes | SSH username |
|
||||
| `password` | string | No | Password for authentication \(if not using private key\) |
|
||||
| `privateKey` | string | No | Private key for authentication \(OpenSSH format\) |
|
||||
| `passphrase` | string | No | Passphrase for encrypted private key |
|
||||
| `path` | string | Yes | Remote file path to write to |
|
||||
| `content` | string | Yes | Content to write to the file |
|
||||
| `mode` | string | No | Write mode: overwrite, append, or create \(default: overwrite\) |
|
||||
| `permissions` | string | No | File permissions \(e.g., 0644\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `written` | boolean | Whether the file was written successfully |
|
||||
| `remotePath` | string | File path |
|
||||
| `size` | number | Final file size in bytes |
|
||||
| `message` | string | Operation status message |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `ssh`
|
||||
571
apps/docs/content/docs/en/tools/wordpress.mdx
Normal file
571
apps/docs/content/docs/en/tools/wordpress.mdx
Normal file
@@ -0,0 +1,571 @@
|
||||
---
|
||||
title: WordPress
|
||||
description: Manage WordPress content
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="wordpress"
|
||||
color="#21759B"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[WordPress](https://wordpress.org/) is the world’s leading open-source content management system, making it easy to publish and manage websites, blogs, and all types of online content. With WordPress, you can create and update posts or pages, organize your content with categories and tags, manage media files, moderate comments, and handle user accounts—allowing you to run everything from personal blogs to complex business sites.
|
||||
|
||||
Sim’s integration with WordPress lets your agents automate essential website tasks. You can programmatically create new blog posts with specific titles, content, categories, tags, and featured images. Updating existing posts—such as changing their content, title, or publishing status—is straightforward. You can also publish or save content as drafts, manage static pages, work with media uploads, oversee comments, and assign content to relevant organizational taxonomies.
|
||||
|
||||
By connecting WordPress to your automations, Sim empowers your agents to streamline content publishing, editorial workflows, and everyday site management—helping you keep your website fresh, organized, and secure without manual effort.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate with WordPress to create, update, and manage posts, pages, media, comments, categories, tags, and users. Supports WordPress.com sites via OAuth and self-hosted WordPress sites using Application Passwords authentication.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `wordpress_create_post`
|
||||
|
||||
Create a new blog post in WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `title` | string | Yes | Post title |
|
||||
| `content` | string | No | Post content \(HTML or plain text\) |
|
||||
| `status` | string | No | Post status: publish, draft, pending, private, or future |
|
||||
| `excerpt` | string | No | Post excerpt |
|
||||
| `categories` | string | No | Comma-separated category IDs |
|
||||
| `tags` | string | No | Comma-separated tag IDs |
|
||||
| `featuredMedia` | number | No | Featured image media ID |
|
||||
| `slug` | string | No | URL slug for the post |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `post` | object | The created post |
|
||||
|
||||
### `wordpress_update_post`
|
||||
|
||||
Update an existing blog post in WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `postId` | number | Yes | The ID of the post to update |
|
||||
| `title` | string | No | Post title |
|
||||
| `content` | string | No | Post content \(HTML or plain text\) |
|
||||
| `status` | string | No | Post status: publish, draft, pending, private, or future |
|
||||
| `excerpt` | string | No | Post excerpt |
|
||||
| `categories` | string | No | Comma-separated category IDs |
|
||||
| `tags` | string | No | Comma-separated tag IDs |
|
||||
| `featuredMedia` | number | No | Featured image media ID |
|
||||
| `slug` | string | No | URL slug for the post |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `post` | object | The updated post |
|
||||
|
||||
### `wordpress_delete_post`
|
||||
|
||||
Delete a blog post from WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `postId` | number | Yes | The ID of the post to delete |
|
||||
| `force` | boolean | No | Bypass trash and force delete permanently |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Whether the post was deleted |
|
||||
| `post` | object | The deleted post |
|
||||
|
||||
### `wordpress_get_post`
|
||||
|
||||
Get a single blog post from WordPress.com by ID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `postId` | number | Yes | The ID of the post to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `post` | object | The retrieved post |
|
||||
|
||||
### `wordpress_list_posts`
|
||||
|
||||
List blog posts from WordPress.com with optional filters
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `perPage` | number | No | Number of posts per page \(default: 10, max: 100\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `status` | string | No | Post status filter: publish, draft, pending, private |
|
||||
| `author` | number | No | Filter by author ID |
|
||||
| `categories` | string | No | Comma-separated category IDs to filter by |
|
||||
| `tags` | string | No | Comma-separated tag IDs to filter by |
|
||||
| `search` | string | No | Search term to filter posts |
|
||||
| `orderBy` | string | No | Order by field: date, id, title, slug, modified |
|
||||
| `order` | string | No | Order direction: asc or desc |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `posts` | array | List of posts |
|
||||
|
||||
### `wordpress_create_page`
|
||||
|
||||
Create a new page in WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `title` | string | Yes | Page title |
|
||||
| `content` | string | No | Page content \(HTML or plain text\) |
|
||||
| `status` | string | No | Page status: publish, draft, pending, private |
|
||||
| `excerpt` | string | No | Page excerpt |
|
||||
| `parent` | number | No | Parent page ID for hierarchical pages |
|
||||
| `menuOrder` | number | No | Order in page menu |
|
||||
| `featuredMedia` | number | No | Featured image media ID |
|
||||
| `slug` | string | No | URL slug for the page |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `page` | object | The created page |
|
||||
|
||||
### `wordpress_update_page`
|
||||
|
||||
Update an existing page in WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `pageId` | number | Yes | The ID of the page to update |
|
||||
| `title` | string | No | Page title |
|
||||
| `content` | string | No | Page content \(HTML or plain text\) |
|
||||
| `status` | string | No | Page status: publish, draft, pending, private |
|
||||
| `excerpt` | string | No | Page excerpt |
|
||||
| `parent` | number | No | Parent page ID for hierarchical pages |
|
||||
| `menuOrder` | number | No | Order in page menu |
|
||||
| `featuredMedia` | number | No | Featured image media ID |
|
||||
| `slug` | string | No | URL slug for the page |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `page` | object | The updated page |
|
||||
|
||||
### `wordpress_delete_page`
|
||||
|
||||
Delete a page from WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `pageId` | number | Yes | The ID of the page to delete |
|
||||
| `force` | boolean | No | Bypass trash and force delete permanently |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Whether the page was deleted |
|
||||
| `page` | object | The deleted page |
|
||||
|
||||
### `wordpress_get_page`
|
||||
|
||||
Get a single page from WordPress.com by ID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `pageId` | number | Yes | The ID of the page to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `page` | object | The retrieved page |
|
||||
|
||||
### `wordpress_list_pages`
|
||||
|
||||
List pages from WordPress.com with optional filters
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `perPage` | number | No | Number of pages per request \(default: 10, max: 100\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `status` | string | No | Page status filter: publish, draft, pending, private |
|
||||
| `parent` | number | No | Filter by parent page ID |
|
||||
| `search` | string | No | Search term to filter pages |
|
||||
| `orderBy` | string | No | Order by field: date, id, title, slug, modified, menu_order |
|
||||
| `order` | string | No | Order direction: asc or desc |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pages` | array | List of pages |
|
||||
|
||||
### `wordpress_upload_media`
|
||||
|
||||
Upload a media file (image, video, document) to WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `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 |
|
||||
| `description` | string | No | Media description |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `media` | object | The uploaded media item |
|
||||
|
||||
### `wordpress_get_media`
|
||||
|
||||
Get a single media item from WordPress.com by ID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `mediaId` | number | Yes | The ID of the media item to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `media` | object | The retrieved media item |
|
||||
|
||||
### `wordpress_list_media`
|
||||
|
||||
List media items from the WordPress.com media library
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `perPage` | number | No | Number of media items per request \(default: 10, max: 100\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `search` | string | No | Search term to filter media |
|
||||
| `mediaType` | string | No | Filter by media type: image, video, audio, application |
|
||||
| `mimeType` | string | No | Filter by specific MIME type \(e.g., image/jpeg\) |
|
||||
| `orderBy` | string | No | Order by field: date, id, title, slug |
|
||||
| `order` | string | No | Order direction: asc or desc |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `media` | array | List of media items |
|
||||
|
||||
### `wordpress_delete_media`
|
||||
|
||||
Delete a media item from WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `mediaId` | number | Yes | The ID of the media item to delete |
|
||||
| `force` | boolean | No | Force delete \(media has no trash, so deletion is permanent\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Whether the media was deleted |
|
||||
| `media` | object | The deleted media item |
|
||||
|
||||
### `wordpress_create_comment`
|
||||
|
||||
Create a new comment on a WordPress.com post
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `postId` | number | Yes | The ID of the post to comment on |
|
||||
| `content` | string | Yes | Comment content |
|
||||
| `parent` | number | No | Parent comment ID for replies |
|
||||
| `authorName` | string | No | Comment author display name |
|
||||
| `authorEmail` | string | No | Comment author email |
|
||||
| `authorUrl` | string | No | Comment author URL |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `comment` | object | The created comment |
|
||||
|
||||
### `wordpress_list_comments`
|
||||
|
||||
List comments from WordPress.com with optional filters
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `perPage` | number | No | Number of comments per request \(default: 10, max: 100\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `postId` | number | No | Filter by post ID |
|
||||
| `status` | string | No | Filter by comment status: approved, hold, spam, trash |
|
||||
| `search` | string | No | Search term to filter comments |
|
||||
| `orderBy` | string | No | Order by field: date, id, parent |
|
||||
| `order` | string | No | Order direction: asc or desc |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `comments` | array | List of comments |
|
||||
|
||||
### `wordpress_update_comment`
|
||||
|
||||
Update a comment in WordPress.com (content or status)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `commentId` | number | Yes | The ID of the comment to update |
|
||||
| `content` | string | No | Updated comment content |
|
||||
| `status` | string | No | Comment status: approved, hold, spam, trash |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `comment` | object | The updated comment |
|
||||
|
||||
### `wordpress_delete_comment`
|
||||
|
||||
Delete a comment from WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `commentId` | number | Yes | The ID of the comment to delete |
|
||||
| `force` | boolean | No | Bypass trash and force delete permanently |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Whether the comment was deleted |
|
||||
| `comment` | object | The deleted comment |
|
||||
|
||||
### `wordpress_create_category`
|
||||
|
||||
Create a new category in WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `name` | string | Yes | Category name |
|
||||
| `description` | string | No | Category description |
|
||||
| `parent` | number | No | Parent category ID for hierarchical categories |
|
||||
| `slug` | string | No | URL slug for the category |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `category` | object | The created category |
|
||||
|
||||
### `wordpress_list_categories`
|
||||
|
||||
List categories from WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `perPage` | number | No | Number of categories per request \(default: 10, max: 100\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `search` | string | No | Search term to filter categories |
|
||||
| `order` | string | No | Order direction: asc or desc |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `categories` | array | List of categories |
|
||||
|
||||
### `wordpress_create_tag`
|
||||
|
||||
Create a new tag in WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `name` | string | Yes | Tag name |
|
||||
| `description` | string | No | Tag description |
|
||||
| `slug` | string | No | URL slug for the tag |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tag` | object | The created tag |
|
||||
|
||||
### `wordpress_list_tags`
|
||||
|
||||
List tags from WordPress.com
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `perPage` | number | No | Number of tags per request \(default: 10, max: 100\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `search` | string | No | Search term to filter tags |
|
||||
| `order` | string | No | Order direction: asc or desc |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tags` | array | List of tags |
|
||||
|
||||
### `wordpress_get_current_user`
|
||||
|
||||
Get information about the currently authenticated WordPress.com user
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | The current user |
|
||||
|
||||
### `wordpress_list_users`
|
||||
|
||||
List users from WordPress.com (requires admin privileges)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `perPage` | number | No | Number of users per request \(default: 10, max: 100\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `search` | string | No | Search term to filter users |
|
||||
| `roles` | string | No | Comma-separated role names to filter by |
|
||||
| `order` | string | No | Order direction: asc or desc |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | List of users |
|
||||
|
||||
### `wordpress_get_user`
|
||||
|
||||
Get a specific user from WordPress.com by ID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `userId` | number | Yes | The ID of the user to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | The retrieved user |
|
||||
|
||||
### `wordpress_search_content`
|
||||
|
||||
Search across all content types in WordPress.com (posts, pages, media)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) |
|
||||
| `query` | string | Yes | Search query |
|
||||
| `perPage` | number | No | Number of results per request \(default: 10, max: 100\) |
|
||||
| `page` | number | No | Page number for pagination |
|
||||
| `type` | string | No | Filter by content type: post, page, attachment |
|
||||
| `subtype` | string | No | Filter by post type slug \(e.g., post, page\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Search results |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `wordpress`
|
||||
@@ -117,6 +117,9 @@ Create a new ticket in Zendesk with support for custom fields
|
||||
| `type` | string | No | Type \(problem, incident, question, task\) |
|
||||
| `tags` | string | No | Comma-separated tags |
|
||||
| `assigneeId` | string | No | Assignee user ID |
|
||||
| `groupId` | string | No | Group ID |
|
||||
| `requesterId` | string | No | Requester user ID |
|
||||
| `customFields` | string | No | Custom fields as JSON object \(e.g., \{"field_id": "value"\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
|
||||
255
apps/docs/content/docs/en/tools/zoom.mdx
Normal file
255
apps/docs/content/docs/en/tools/zoom.mdx
Normal file
@@ -0,0 +1,255 @@
|
||||
---
|
||||
title: Zoom
|
||||
description: Create and manage Zoom meetings and recordings
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="zoom"
|
||||
color="#2D8CFF"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Zoom](https://zoom.us/) is a leading cloud-based communications platform for video meetings, webinars, and online collaboration. It allows users and organizations to easily schedule, host, and manage meetings, providing tools for screen sharing, chat, recordings, and more.
|
||||
|
||||
With Zoom, you can:
|
||||
|
||||
- **Schedule and manage meetings**: Create instant or scheduled meetings, including recurring events
|
||||
- **Configure meeting options**: Set meeting passwords, enable waiting rooms, and control participant video/audio
|
||||
- **Send invitations and share details**: Retrieve meeting invitations and information for easy sharing
|
||||
- **Get and update meeting data**: Access meeting details, modify existing meetings, and manage settings programmatically
|
||||
|
||||
In Sim, the Zoom integration empowers your agents to automate scheduling and meeting management. Use tool actions to:
|
||||
|
||||
- Programmatically create new meetings with custom settings
|
||||
- List all meetings for a specific user (or yourself)
|
||||
- Retrieve details or invitations for any meeting
|
||||
- Update or delete existing meetings directly from your automations
|
||||
|
||||
These capabilities let you streamline remote collaboration, automate recurring video sessions, and manage your organization's Zoom environment all as part of your workflows.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Integrate Zoom into workflows. Create, list, update, and delete Zoom meetings. Get meeting details, invitations, recordings, and participants. Manage cloud recordings programmatically.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `zoom_create_meeting`
|
||||
|
||||
Create a new Zoom meeting
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `userId` | string | Yes | The user ID or email address. Use "me" for the authenticated user. |
|
||||
| `topic` | string | Yes | Meeting topic |
|
||||
| `type` | number | No | Meeting type: 1=instant, 2=scheduled, 3=recurring no fixed time, 8=recurring fixed time |
|
||||
| `startTime` | string | No | Meeting start time in ISO 8601 format \(e.g., 2025-06-03T10:00:00Z\) |
|
||||
| `duration` | number | No | Meeting duration in minutes |
|
||||
| `timezone` | string | No | Timezone for the meeting \(e.g., America/Los_Angeles\) |
|
||||
| `password` | string | No | Meeting password |
|
||||
| `agenda` | string | No | Meeting agenda |
|
||||
| `hostVideo` | boolean | No | Start with host video on |
|
||||
| `participantVideo` | boolean | No | Start with participant video on |
|
||||
| `joinBeforeHost` | boolean | No | Allow participants to join before host |
|
||||
| `muteUponEntry` | boolean | No | Mute participants upon entry |
|
||||
| `waitingRoom` | boolean | No | Enable waiting room |
|
||||
| `autoRecording` | string | No | Auto recording setting: local, cloud, or none |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `meeting` | object | The created meeting with all its properties |
|
||||
|
||||
### `zoom_list_meetings`
|
||||
|
||||
List all meetings for a Zoom user
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `userId` | string | Yes | The user ID or email address. Use "me" for the authenticated user. |
|
||||
| `type` | string | No | Meeting type filter: scheduled, live, upcoming, upcoming_meetings, or previous_meetings |
|
||||
| `pageSize` | number | No | Number of records per page \(max 300\) |
|
||||
| `nextPageToken` | string | No | Token for pagination to get next page of results |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `meetings` | array | List of meetings |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
|
||||
### `zoom_get_meeting`
|
||||
|
||||
Get details of a specific Zoom meeting
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Yes | The meeting ID |
|
||||
| `occurrenceId` | string | No | Occurrence ID for recurring meetings |
|
||||
| `showPreviousOccurrences` | boolean | No | Show previous occurrences for recurring meetings |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `meeting` | object | The meeting details |
|
||||
|
||||
### `zoom_update_meeting`
|
||||
|
||||
Update an existing Zoom meeting
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Yes | The meeting ID to update |
|
||||
| `topic` | string | No | Meeting topic |
|
||||
| `type` | number | No | Meeting type: 1=instant, 2=scheduled, 3=recurring no fixed time, 8=recurring fixed time |
|
||||
| `startTime` | string | No | Meeting start time in ISO 8601 format \(e.g., 2025-06-03T10:00:00Z\) |
|
||||
| `duration` | number | No | Meeting duration in minutes |
|
||||
| `timezone` | string | No | Timezone for the meeting \(e.g., America/Los_Angeles\) |
|
||||
| `password` | string | No | Meeting password |
|
||||
| `agenda` | string | No | Meeting agenda |
|
||||
| `hostVideo` | boolean | No | Start with host video on |
|
||||
| `participantVideo` | boolean | No | Start with participant video on |
|
||||
| `joinBeforeHost` | boolean | No | Allow participants to join before host |
|
||||
| `muteUponEntry` | boolean | No | Mute participants upon entry |
|
||||
| `waitingRoom` | boolean | No | Enable waiting room |
|
||||
| `autoRecording` | string | No | Auto recording setting: local, cloud, or none |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the meeting was updated successfully |
|
||||
|
||||
### `zoom_delete_meeting`
|
||||
|
||||
Delete or cancel a Zoom meeting
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Yes | The meeting ID to delete |
|
||||
| `occurrenceId` | string | No | Occurrence ID for deleting a specific occurrence of a recurring meeting |
|
||||
| `scheduleForReminder` | boolean | No | Send cancellation reminder email to registrants |
|
||||
| `cancelMeetingReminder` | boolean | No | Send cancellation email to registrants and alternative hosts |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the meeting was deleted successfully |
|
||||
|
||||
### `zoom_get_meeting_invitation`
|
||||
|
||||
Get the meeting invitation text for a Zoom meeting
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Yes | The meeting ID |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `invitation` | string | The meeting invitation text |
|
||||
|
||||
### `zoom_list_recordings`
|
||||
|
||||
List all cloud recordings for a Zoom user
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `userId` | string | Yes | The user ID or email address. Use "me" for the authenticated user. |
|
||||
| `from` | string | No | Start date in yyyy-mm-dd format \(within last 6 months\) |
|
||||
| `to` | string | No | End date in yyyy-mm-dd format |
|
||||
| `pageSize` | number | No | Number of records per page \(max 300\) |
|
||||
| `nextPageToken` | string | No | Token for pagination to get next page of results |
|
||||
| `trash` | boolean | No | Set to true to list recordings from trash |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `recordings` | array | List of recordings |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
|
||||
### `zoom_get_meeting_recordings`
|
||||
|
||||
Get all recordings for a specific Zoom meeting
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Yes | The meeting ID or meeting UUID |
|
||||
| `includeFolderItems` | boolean | No | Include items within a folder |
|
||||
| `ttl` | number | No | Time to live for download URLs in seconds \(max 604800\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `recording` | object | The meeting recording with all files |
|
||||
|
||||
### `zoom_delete_recording`
|
||||
|
||||
Delete cloud recordings for a Zoom meeting
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Yes | The meeting ID or meeting UUID |
|
||||
| `recordingId` | string | No | Specific recording file ID to delete. If not provided, deletes all recordings. |
|
||||
| `action` | string | No | Delete action: "trash" \(move to trash\) or "delete" \(permanently delete\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the recording was deleted successfully |
|
||||
|
||||
### `zoom_list_past_participants`
|
||||
|
||||
List participants from a past Zoom meeting
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Yes | The past meeting ID or UUID |
|
||||
| `pageSize` | number | No | Number of records per page \(max 300\) |
|
||||
| `nextPageToken` | string | No | Token for pagination to get next page of results |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `participants` | array | List of meeting participants |
|
||||
| `pageInfo` | object | Pagination information |
|
||||
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `tools`
|
||||
- Type: `zoom`
|
||||
@@ -66,16 +66,16 @@ To reference environment variables in your workflows, use the `{{}}` notation. W
|
||||
height={350}
|
||||
/>
|
||||
|
||||
## Variable Precedence
|
||||
## How Variables are Resolved
|
||||
|
||||
When you have both personal and workspace variables with the same name:
|
||||
**Workspace variables always take precedence** over personal variables, regardless of who runs the workflow.
|
||||
|
||||
1. **Workspace variables take precedence** over personal variables
|
||||
2. This prevents naming conflicts and ensures consistent behavior across team workflows
|
||||
3. If a workspace variable exists, the personal variable with the same name is ignored
|
||||
When no workspace variable exists for a key, personal variables are used:
|
||||
- **Manual runs (UI)**: Your personal variables
|
||||
- **Automated runs (API, webhook, schedule, deployed chat)**: Workflow owner's personal variables
|
||||
|
||||
<Callout type="warning">
|
||||
Choose variable names carefully to avoid unintended overrides. Consider prefixing personal variables with your initials or workspace variables with the project name.
|
||||
<Callout type="info">
|
||||
Personal variables are best for testing. Use workspace variables for production workflows.
|
||||
</Callout>
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
@@ -251,32 +251,78 @@ Recupera detalles de ejecución incluyendo la instantánea del estado del flujo
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Suscripciones a webhooks
|
||||
## Notificaciones
|
||||
|
||||
Recibe notificaciones en tiempo real cuando se completan las ejecuciones de flujos de trabajo. Los webhooks se configuran a través de la interfaz de usuario de Sim en el editor de flujos de trabajo.
|
||||
Recibe notificaciones en tiempo real cuando se completan las ejecuciones de flujos de trabajo a través de webhook, correo electrónico o Slack. Las notificaciones se configuran a nivel de espacio de trabajo desde la página de Registros.
|
||||
|
||||
### Configuración
|
||||
|
||||
Los webhooks pueden configurarse para cada flujo de trabajo a través de la interfaz de usuario del editor de flujos de trabajo. Haz clic en el icono de webhook en la barra de control para configurar tus suscripciones a webhooks.
|
||||
Configura las notificaciones desde la página de Registros haciendo clic en el botón de menú y seleccionando "Configurar notificaciones".
|
||||
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<Video src="configure-webhook.mp4" width={700} height={450} />
|
||||
</div>
|
||||
**Canales de notificación:**
|
||||
- **Webhook**: Envía solicitudes HTTP POST a tu punto de conexión
|
||||
- **Correo electrónico**: Recibe notificaciones por correo con detalles de la ejecución
|
||||
- **Slack**: Publica mensajes en un canal de Slack
|
||||
|
||||
**Opciones de configuración disponibles:**
|
||||
- `url`: URL del punto final de tu webhook
|
||||
**Selección de flujos de trabajo:**
|
||||
- Selecciona flujos de trabajo específicos para monitorear
|
||||
- O elige "Todos los flujos de trabajo" para incluir los flujos actuales y futuros
|
||||
|
||||
**Opciones de filtrado:**
|
||||
- `levelFilter`: Niveles de registro a recibir (`info`, `error`)
|
||||
- `triggerFilter`: Tipos de disparadores a recibir (`api`, `webhook`, `schedule`, `manual`, `chat`)
|
||||
|
||||
**Datos opcionales:**
|
||||
- `includeFinalOutput`: Incluir la salida final del flujo de trabajo
|
||||
- `includeTraceSpans`: Incluir trazas detalladas de la ejecución
|
||||
- `includeRateLimits`: Incluir información de límites de tasa (límites sincrónicos/asincrónicos y restantes)
|
||||
- `includeUsageData`: Incluir uso y límites del período de facturación
|
||||
|
||||
### Reglas de alerta
|
||||
|
||||
En lugar de recibir notificaciones por cada ejecución, configura reglas de alerta para ser notificado solo cuando se detecten problemas:
|
||||
|
||||
**Fallos consecutivos**
|
||||
- Alerta después de X ejecuciones fallidas consecutivas (por ejemplo, 3 fallos seguidos)
|
||||
- Se reinicia cuando una ejecución tiene éxito
|
||||
|
||||
**Tasa de fallos**
|
||||
- Alerta cuando la tasa de fallos supera el X% durante las últimas Y horas
|
||||
- Requiere un mínimo de 5 ejecuciones en la ventana de tiempo
|
||||
- Solo se activa después de que haya transcurrido la ventana de tiempo completa
|
||||
|
||||
**Umbral de latencia**
|
||||
- Alerta cuando cualquier ejecución tarda más de X segundos
|
||||
- Útil para detectar flujos de trabajo lentos o bloqueados
|
||||
|
||||
**Pico de latencia**
|
||||
- Alerta cuando la ejecución es X% más lenta que el promedio
|
||||
- Compara con la duración promedio durante la ventana de tiempo configurada
|
||||
- Requiere un mínimo de 5 ejecuciones para establecer una línea base
|
||||
|
||||
**Umbral de costo**
|
||||
- Alerta cuando una sola ejecución cuesta más de $X
|
||||
- Útil para detectar llamadas costosas a LLM
|
||||
|
||||
**Sin actividad**
|
||||
- Alerta cuando no ocurren ejecuciones dentro de X horas
|
||||
- Útil para monitorear flujos de trabajo programados que deberían ejecutarse regularmente
|
||||
|
||||
**Recuento de errores**
|
||||
- Alerta cuando el recuento de errores excede X dentro de una ventana de tiempo
|
||||
- Rastrea errores totales, no consecutivos
|
||||
|
||||
Todos los tipos de alertas incluyen un período de enfriamiento de 1 hora para evitar el spam de notificaciones.
|
||||
|
||||
### Configuración de webhook
|
||||
|
||||
Para webhooks, hay opciones adicionales disponibles:
|
||||
- `url`: La URL de tu endpoint webhook
|
||||
- `secret`: Secreto opcional para verificación de firma HMAC
|
||||
- `includeFinalOutput`: Incluir la salida final del flujo de trabajo en la carga útil
|
||||
- `includeTraceSpans`: Incluir intervalos de seguimiento de ejecución detallados
|
||||
- `includeRateLimits`: Incluir información del límite de tasa del propietario del flujo de trabajo
|
||||
- `includeUsageData`: Incluir datos de uso y facturación del propietario del flujo de trabajo
|
||||
- `levelFilter`: Array de niveles de registro a recibir (`info`, `error`)
|
||||
- `triggerFilter`: Array de tipos de disparadores a recibir (`api`, `webhook`, `schedule`, `manual`, `chat`)
|
||||
- `active`: Habilitar/deshabilitar la suscripción al webhook
|
||||
|
||||
### Carga útil del webhook
|
||||
### Estructura de carga útil
|
||||
|
||||
Cuando se completa la ejecución de un flujo de trabajo, Sim envía una solicitud POST a tu URL de webhook:
|
||||
Cuando se completa la ejecución de un flujo de trabajo, Sim envía la siguiente carga útil (vía webhook POST, correo electrónico o Slack):
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -325,9 +371,9 @@ Cuando se completa la ejecución de un flujo de trabajo, Sim envía una solicitu
|
||||
}
|
||||
```
|
||||
|
||||
### Cabeceras de webhook
|
||||
### Encabezados de webhook
|
||||
|
||||
Cada solicitud de webhook incluye estas cabeceras:
|
||||
Cada solicitud de webhook incluye estos encabezados (solo canal webhook):
|
||||
|
||||
- `sim-event`: Tipo de evento (siempre `workflow.execution.completed`)
|
||||
- `sim-timestamp`: Marca de tiempo Unix en milisegundos
|
||||
@@ -416,15 +462,15 @@ Las entregas de webhook fallidas se reintentan con retroceso exponencial y fluct
|
||||
- Retrasos de reintento: 5 segundos, 15 segundos, 1 minuto, 3 minutos, 10 minutos
|
||||
- Fluctuación: Hasta un 10% de retraso adicional para prevenir el efecto de manada
|
||||
- Solo las respuestas HTTP 5xx y 429 activan reintentos
|
||||
- Las entregas agotan el tiempo de espera después de 30 segundos
|
||||
- Las entregas agotan el tiempo después de 30 segundos
|
||||
|
||||
<Callout type="info">
|
||||
Las entregas de webhook se procesan de forma asíncrona y no afectan al rendimiento de ejecución del flujo de trabajo.
|
||||
Las entregas de webhook se procesan de forma asíncrona y no afectan el rendimiento de ejecución del flujo de trabajo.
|
||||
</Callout>
|
||||
|
||||
## Mejores prácticas
|
||||
|
||||
1. **Estrategia de sondeo**: Al sondear registros, utiliza paginación basada en cursor con `order=asc` y `startDate` para obtener nuevos registros de manera eficiente.
|
||||
1. **Estrategia de sondeo**: Cuando consultes registros, utiliza paginación basada en cursores con `order=asc` y `startDate` para obtener nuevos registros de manera eficiente.
|
||||
|
||||
2. **Seguridad de webhook**: Siempre configura un secreto de webhook y verifica las firmas para asegurar que las solicitudes provienen de Sim.
|
||||
|
||||
@@ -432,23 +478,23 @@ Las entregas de webhook fallidas se reintentan con retroceso exponencial y fluct
|
||||
|
||||
4. **Privacidad**: Por defecto, `finalOutput` y `traceSpans` están excluidos de las respuestas. Habilítalos solo si necesitas los datos y comprendes las implicaciones de privacidad.
|
||||
|
||||
5. **Limitación de tasa**: Implementa retroceso exponencial cuando recibas respuestas 429. Consulta la cabecera `Retry-After` para conocer el tiempo de espera recomendado.
|
||||
5. **Limitación de tasa**: Implementa retroceso exponencial cuando recibas respuestas 429. Verifica la cabecera `Retry-After` para conocer el tiempo de espera recomendado.
|
||||
|
||||
## Limitación de tasa
|
||||
|
||||
La API implementa limitación de tasa para garantizar un uso justo:
|
||||
La API implementa limitación de tasa para asegurar un uso justo:
|
||||
|
||||
- **Plan gratuito**: 10 solicitudes por minuto
|
||||
- **Plan Pro**: 30 solicitudes por minuto
|
||||
- **Plan Team**: 60 solicitudes por minuto
|
||||
- **Plan Enterprise**: Límites personalizados
|
||||
|
||||
La información del límite de tasa se incluye en los encabezados de respuesta:
|
||||
- `X-RateLimit-Limit`: Máximo de solicitudes por ventana
|
||||
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 se reinicia la ventana
|
||||
- `X-RateLimit-Reset`: Marca de tiempo ISO cuando la ventana se reinicia
|
||||
|
||||
## Ejemplo: Sondeo para nuevos registros
|
||||
## Ejemplo: Sondeo de nuevos registros
|
||||
|
||||
```javascript
|
||||
let cursor = null;
|
||||
|
||||
@@ -147,4 +147,4 @@ La instantánea proporciona:
|
||||
|
||||
- Aprende sobre [Cálculo de costos](/execution/costs) para entender los precios de los flujos de trabajo
|
||||
- Explora la [API externa](/execution/api) para acceso programático a los registros
|
||||
- Configura [notificaciones por Webhook](/execution/api#webhook-subscriptions) para alertas en tiempo real
|
||||
- Configura [Notificaciones](/execution/api#notifications) para alertas en tiempo real vía webhook, correo electrónico o Slack
|
||||
199
apps/docs/content/docs/es/tools/ahrefs.mdx
Normal file
199
apps/docs/content/docs/es/tools/ahrefs.mdx
Normal file
@@ -0,0 +1,199 @@
|
||||
---
|
||||
title: Ahrefs
|
||||
description: Análisis SEO con Ahrefs
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="ahrefs"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Ahrefs](https://ahrefs.com/) es un conjunto de herramientas SEO líder para analizar sitios web, seguir posiciones, monitorear backlinks e investigar palabras clave. Proporciona información detallada sobre tu propio sitio web y el de tus competidores, ayudándote a tomar decisiones basadas en datos para mejorar tu visibilidad en los buscadores.
|
||||
|
||||
Con la integración de Ahrefs en Sim, puedes:
|
||||
|
||||
- **Analizar Domain Rating y autoridad**: Comprobar instantáneamente el Domain Rating (DR) y el Ahrefs Rank de cualquier sitio web para evaluar su autoridad.
|
||||
- **Obtener backlinks**: Recuperar una lista de backlinks que apuntan a un sitio o URL específica, con detalles como texto ancla, DR de la página referente y más.
|
||||
- **Obtener estadísticas de backlinks**: Acceder a métricas sobre tipos de backlinks (dofollow, nofollow, texto, imagen, redirección, etc.) para un dominio o URL.
|
||||
- **Explorar palabras clave orgánicas** *(planificado)*: Ver las palabras clave por las que un dominio se posiciona y sus posiciones en los resultados de búsqueda de Google.
|
||||
- **Descubrir páginas principales** *(planificado)*: Identificar las páginas con mejor rendimiento por tráfico orgánico y enlaces.
|
||||
|
||||
Estas herramientas permiten a tus agentes automatizar la investigación SEO, monitorear competidores y generar informes, todo como parte de tus automatizaciones de flujo de trabajo. Para usar la integración de Ahrefs, necesitarás una suscripción Ahrefs Enterprise con acceso a API.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra las herramientas SEO de Ahrefs en tu flujo de trabajo. Analiza calificaciones de dominio, backlinks, palabras clave orgánicas, páginas principales y más. Requiere un plan Ahrefs Enterprise con acceso a API.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `ahrefs_domain_rating`
|
||||
|
||||
Obtén el Domain Rating (DR) y el Ahrefs Rank para un dominio objetivo. El Domain Rating muestra la fortaleza de un sitio web
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Sí | El dominio objetivo a analizar \(p. ej., example.com\) |
|
||||
| `date` | string | No | Fecha para datos históricos en formato AAAA-MM-DD \(por defecto es hoy\) |
|
||||
| `apiKey` | string | Sí | Clave API de Ahrefs |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `domainRating` | number | Puntuación de Domain Rating \(0-100\) |
|
||||
| `ahrefsRank` | number | Ahrefs Rank - clasificación global basada en la fuerza del perfil de backlinks |
|
||||
|
||||
### `ahrefs_backlinks`
|
||||
|
||||
Obtener una lista de backlinks que apuntan a un dominio o URL objetivo. Devuelve detalles sobre cada backlink incluyendo URL de origen, texto de anclaje y domain rating.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Sí | El dominio o URL objetivo a analizar |
|
||||
| `mode` | string | No | Modo de análisis: domain \(dominio completo\), prefix \(prefijo URL\), subdomains \(incluir todos los subdominios\), exact \(coincidencia exacta de URL\) |
|
||||
| `date` | string | No | Fecha para datos históricos en formato AAAA-MM-DD \(por defecto es hoy\) |
|
||||
| `limit` | number | No | Número máximo de resultados a devolver \(predeterminado: 100\) |
|
||||
| `offset` | number | No | Número de resultados a omitir para paginación |
|
||||
| `apiKey` | string | Sí | Clave API de Ahrefs |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `backlinks` | array | Lista de backlinks que apuntan al objetivo |
|
||||
|
||||
### `ahrefs_backlinks_stats`
|
||||
|
||||
Obtén estadísticas de backlinks para un dominio o URL objetivo. Devuelve totales para diferentes tipos de backlinks incluyendo enlaces dofollow, nofollow, texto, imagen y redirección.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Sí | El dominio o URL objetivo para analizar |
|
||||
| `mode` | string | No | Modo de análisis: domain \(dominio completo\), prefix \(prefijo URL\), subdomains \(incluir todos los subdominios\), exact \(coincidencia exacta de URL\) |
|
||||
| `date` | string | No | Fecha para datos históricos en formato AAAA-MM-DD \(por defecto es hoy\) |
|
||||
| `apiKey` | string | Sí | Clave API de Ahrefs |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `stats` | object | Resumen de estadísticas de backlinks |
|
||||
|
||||
### `ahrefs_referring_domains`
|
||||
|
||||
Obtén una lista de dominios que enlazan a un dominio o URL objetivo. Devuelve dominios de referencia únicos con su calificación de dominio, recuento de backlinks y fechas de descubrimiento.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Sí | El dominio o URL objetivo para analizar |
|
||||
| `mode` | string | No | Modo de análisis: domain \(dominio completo\), prefix \(prefijo URL\), subdomains \(incluir todos los subdominios\), exact \(coincidencia exacta de URL\) |
|
||||
| `date` | string | No | Fecha para datos históricos en formato AAAA-MM-DD \(por defecto es hoy\) |
|
||||
| `limit` | number | No | Número máximo de resultados a devolver \(predeterminado: 100\) |
|
||||
| `offset` | number | No | Número de resultados a omitir para paginación |
|
||||
| `apiKey` | string | Sí | Clave API de Ahrefs |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `referringDomains` | array | Lista de dominios que enlazan al objetivo |
|
||||
|
||||
### `ahrefs_organic_keywords`
|
||||
|
||||
Obtén palabras clave orgánicas por las que un dominio o URL objetivo se posiciona en los resultados de búsqueda de Google. Devuelve detalles de las palabras clave, incluyendo volumen de búsqueda, posición en el ranking y tráfico estimado.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `target` | string | Sí | El dominio o URL objetivo a analizar |
|
||||
| `country` | string | No | Código de país para los resultados de búsqueda \(p. ej., us, gb, de\). Predeterminado: us |
|
||||
| `mode` | string | No | Modo de análisis: domain \(dominio completo\), prefix \(prefijo de URL\), subdomains \(incluir todos los subdominios\), exact \(coincidencia exacta de URL\) |
|
||||
| `date` | string | No | Fecha para datos históricos en formato AAAA-MM-DD \(por defecto: hoy\) |
|
||||
| `limit` | number | No | Número máximo de resultados a devolver \(predeterminado: 100\) |
|
||||
| `offset` | number | No | Número de resultados a omitir para la paginación |
|
||||
| `apiKey` | string | Sí | Clave API de Ahrefs |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `keywords` | array | Lista de palabras clave orgánicas por las que se posiciona el objetivo |
|
||||
|
||||
### `ahrefs_top_pages`
|
||||
|
||||
Obtén las páginas principales de un dominio objetivo ordenadas por tráfico orgánico. Devuelve URLs de páginas con su tráfico, recuento de palabras clave y valor estimado del tráfico.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `target` | string | Sí | El dominio objetivo para analizar |
|
||||
| `country` | string | No | Código de país para datos de tráfico \(p. ej., us, gb, de\). Predeterminado: us |
|
||||
| `mode` | string | No | Modo de análisis: domain \(dominio completo\), prefix \(prefijo URL\), subdomains \(incluir todos los subdominios\) |
|
||||
| `date` | string | No | Fecha para datos históricos en formato AAAA-MM-DD \(predeterminado: hoy\) |
|
||||
| `limit` | number | No | Número máximo de resultados a devolver \(predeterminado: 100\) |
|
||||
| `offset` | number | No | Número de resultados a omitir para paginación |
|
||||
| `apiKey` | string | Sí | Clave API de Ahrefs |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pages` | array | Lista de páginas principales por tráfico orgánico |
|
||||
|
||||
### `ahrefs_keyword_overview`
|
||||
|
||||
Obtener métricas detalladas para una palabra clave incluyendo volumen de búsqueda, dificultad de la palabra clave, CPC, clics y potencial de tráfico.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `keyword` | string | Sí | La palabra clave a analizar |
|
||||
| `country` | string | No | Código de país para datos de palabras clave \(p. ej., us, gb, de\). Predeterminado: us |
|
||||
| `apiKey` | string | Sí | Clave API de Ahrefs |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `overview` | object | Resumen de métricas de palabra clave |
|
||||
|
||||
### `ahrefs_broken_backlinks`
|
||||
|
||||
Obtén una lista de backlinks rotos que apuntan a un dominio o URL objetivo. Útil para identificar oportunidades de recuperación de enlaces.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `target` | string | Sí | El dominio o URL objetivo para analizar |
|
||||
| `mode` | string | No | Modo de análisis: domain \(dominio completo\), prefix \(prefijo de URL\), subdomains \(incluir todos los subdominios\), exact \(coincidencia exacta de URL\) |
|
||||
| `date` | string | No | Fecha para datos históricos en formato AAAA-MM-DD \(por defecto: hoy\) |
|
||||
| `limit` | number | No | Número máximo de resultados a devolver \(predeterminado: 100\) |
|
||||
| `offset` | number | No | Número de resultados a omitir para paginación |
|
||||
| `apiKey` | string | Sí | Clave API de Ahrefs |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `brokenBacklinks` | array | Lista de backlinks rotos |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `ahrefs`
|
||||
89
apps/docs/content/docs/es/tools/apify.mdx
Normal file
89
apps/docs/content/docs/es/tools/apify.mdx
Normal file
@@ -0,0 +1,89 @@
|
||||
---
|
||||
title: Apify
|
||||
description: Ejecuta actores de Apify y obtén resultados
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="apify"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Apify](https://apify.com/) es una plataforma potente para crear, implementar y ejecutar automatización web y actores de scraping web a escala. Apify te permite extraer datos útiles de cualquier sitio web, automatizar flujos de trabajo y conectar tus canales de datos sin problemas.
|
||||
|
||||
Con Apify, puedes:
|
||||
|
||||
- **Ejecutar actores predefinidos o personalizados**: Integra actores públicos o desarrolla los tuyos propios, automatizando una amplia gama de tareas de extracción de datos web y navegador.
|
||||
- **Recuperar conjuntos de datos**: Accede y gestiona conjuntos de datos estructurados recopilados por actores en tiempo real.
|
||||
- **Escalar la automatización web**: Aprovecha la infraestructura en la nube para ejecutar tareas de manera confiable, de forma asíncrona o síncrona, con un manejo robusto de errores.
|
||||
|
||||
En Sim, la integración de Apify permite a tus agentes realizar operaciones principales de Apify de forma programática:
|
||||
|
||||
- **Ejecutar actor (Sincrónico)**: Usa `apify_run_actor_sync` para lanzar un actor de Apify y esperar a que se complete, obteniendo los resultados tan pronto como finalice la ejecución.
|
||||
- **Ejecutar actor (Asincrónico)**: Usa `apify_run_actor_async` para iniciar un actor en segundo plano y consultar periódicamente los resultados, adecuado para trabajos más largos o complejos.
|
||||
|
||||
Estas operaciones equipan a tus agentes para automatizar, extraer y orquestar tareas de recopilación de datos o automatización de navegador directamente dentro de los flujos de trabajo — todo con configuración flexible y manejo de resultados, sin necesidad de ejecuciones manuales o herramientas externas. Integra Apify como un motor dinámico de automatización y extracción de datos que impulsa programáticamente los flujos de trabajo a escala web de tus agentes.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra Apify en tu flujo de trabajo. Ejecuta cualquier actor de Apify con entrada personalizada y obtén resultados. Admite ejecución tanto síncrona como asíncrona con recuperación automática de conjuntos de datos.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `apify_run_actor_sync`
|
||||
|
||||
Ejecuta un actor de APIFY de forma sincrónica y obtén resultados (máximo 5 minutos)
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de API de APIFY desde console.apify.com/account#/integrations |
|
||||
| `actorId` | string | Sí | ID del actor o nombreusuario/nombre-actor \(p.ej., "janedoe/my-actor" o ID del actor\) |
|
||||
| `input` | string | No | Entrada del actor como cadena JSON. Consulta la documentación del actor para los campos requeridos. |
|
||||
| `timeout` | number | No | Tiempo de espera en segundos \(predeterminado: el predeterminado del actor\) |
|
||||
| `build` | string | No | Versión del actor a ejecutar \(p.ej., "latest", "beta", o etiqueta/número de versión\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la ejecución del actor tuvo éxito |
|
||||
| `runId` | string | ID de ejecución de APIFY |
|
||||
| `status` | string | Estado de la ejecución \(SUCCEEDED, FAILED, etc.\) |
|
||||
| `datasetId` | string | ID del conjunto de datos que contiene los resultados |
|
||||
| `items` | array | Elementos del conjunto de datos \(si se completó\) |
|
||||
|
||||
### `apify_run_actor_async`
|
||||
|
||||
Ejecuta un actor de APIFY de forma asincrónica con sondeo para tareas de larga duración
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de API de APIFY desde console.apify.com/account#/integrations |
|
||||
| `actorId` | string | Sí | ID del actor o nombreusuario/nombre-actor \(p.ej., "janedoe/my-actor" o ID del actor\) |
|
||||
| `input` | string | No | Entrada del actor como cadena JSON |
|
||||
| `waitForFinish` | number | No | Tiempo de espera inicial en segundos \(0-60\) antes de que comience el sondeo |
|
||||
| `itemLimit` | number | No | Número máximo de elementos del conjunto de datos a recuperar \(1-250000, predeterminado 100\) |
|
||||
| `timeout` | number | No | Tiempo de espera en segundos \(predeterminado: el predeterminado del actor\) |
|
||||
| `build` | string | No | Versión del actor a ejecutar \(p.ej., "latest", "beta", o etiqueta/número de versión\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la ejecución del actor tuvo éxito |
|
||||
| `runId` | string | ID de ejecución de APIFY |
|
||||
| `status` | string | Estado de la ejecución \(SUCCEEDED, FAILED, etc.\) |
|
||||
| `datasetId` | string | ID del conjunto de datos que contiene los resultados |
|
||||
| `items` | array | Elementos del conjunto de datos \(si se completó\) |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `apify`
|
||||
302
apps/docs/content/docs/es/tools/datadog.mdx
Normal file
302
apps/docs/content/docs/es/tools/datadog.mdx
Normal file
@@ -0,0 +1,302 @@
|
||||
---
|
||||
title: Datadog
|
||||
description: Monitorea infraestructura, aplicaciones y registros con Datadog
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="datadog"
|
||||
color="#632CA6"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Datadog](https://datadoghq.com/) es una plataforma integral de monitoreo y análisis para infraestructura, aplicaciones, registros y más. Permite a las organizaciones obtener visibilidad en tiempo real sobre la salud y el rendimiento de los sistemas, detectar anomalías y automatizar la respuesta a incidentes.
|
||||
|
||||
Con Datadog, puedes:
|
||||
|
||||
- **Monitorear métricas**: Recopilar, visualizar y analizar métricas de servidores, servicios en la nube y aplicaciones personalizadas.
|
||||
- **Consultar datos de series temporales**: Ejecutar consultas avanzadas sobre métricas de rendimiento para análisis de tendencias e informes.
|
||||
- **Gestionar monitores y eventos**: Configurar monitores para detectar problemas, activar alertas y crear eventos para observabilidad.
|
||||
- **Manejar tiempos de inactividad**: Programar y gestionar de forma programática los tiempos de inactividad planificados para suprimir alertas durante el mantenimiento.
|
||||
- **Analizar registros y trazas** *(con configuración adicional en Datadog)*: Centralizar e inspeccionar registros o trazas distribuidas para una solución de problemas más profunda.
|
||||
|
||||
La integración de Datadog de Sim permite que tus agentes automaticen estas operaciones e interactúen con tu cuenta de Datadog de forma programática. Úsala para enviar métricas personalizadas, consultar datos de series temporales, gestionar monitores, crear eventos y optimizar tus flujos de trabajo de monitoreo directamente dentro de las automatizaciones de Sim.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra el monitoreo de Datadog en los flujos de trabajo. Envía métricas, gestiona monitores, consulta registros, crea eventos, maneja tiempos de inactividad y más.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `datadog_submit_metrics`
|
||||
|
||||
Envía métricas personalizadas a Datadog. Utilízalo para seguir el rendimiento de aplicaciones, métricas de negocio o datos de monitoreo personalizados.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `series` | string | Sí | Array JSON de series métricas para enviar. Cada serie debe incluir nombre de métrica, tipo \(gauge/rate/count\), puntos \(pares de marca de tiempo/valor\) y etiquetas opcionales. |
|
||||
| `apiKey` | string | Sí | Clave API de Datadog |
|
||||
| `site` | string | No | Sitio/región de Datadog \(predeterminado: datadoghq.com\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Indica si las métricas se enviaron correctamente |
|
||||
| `errors` | array | Cualquier error que haya ocurrido durante el envío |
|
||||
|
||||
### `datadog_query_timeseries`
|
||||
|
||||
Consulta datos de series temporales de métricas desde Datadog. Útil para analizar tendencias, crear informes o recuperar valores de métricas.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Sí | Consulta de métricas de Datadog (p. ej., "avg:system.cpu.user\{*\}") |
|
||||
| `from` | number | Sí | Tiempo de inicio como marca de tiempo Unix en segundos |
|
||||
| `to` | number | Sí | Tiempo de finalización como marca de tiempo Unix en segundos |
|
||||
| `apiKey` | string | Sí | Clave API de Datadog |
|
||||
| `applicationKey` | string | Sí | Clave de aplicación de Datadog |
|
||||
| `site` | string | No | Sitio/región de Datadog (predeterminado: datadoghq.com) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `series` | array | Array de datos de series temporales con nombre de métrica, etiquetas y puntos de datos |
|
||||
| `status` | string | Estado de la consulta |
|
||||
|
||||
### `datadog_create_event`
|
||||
|
||||
Publica un evento en el flujo de eventos de Datadog. Útil para notificaciones de despliegue, alertas o cualquier suceso significativo.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `title` | string | Sí | Título del evento |
|
||||
| `text` | string | Sí | Cuerpo/descripción del evento. Admite markdown. |
|
||||
| `alertType` | string | No | Tipo de alerta: error, warning, info, success, user_update, recommendation o snapshot |
|
||||
| `priority` | string | No | Prioridad del evento: normal o low |
|
||||
| `host` | string | No | Nombre del host asociado con este evento |
|
||||
| `tags` | string | No | Lista de etiquetas separadas por comas (p. ej., "env:production,service:api") |
|
||||
| `aggregationKey` | string | No | Clave para agrupar eventos |
|
||||
| `sourceTypeName` | string | No | Nombre del tipo de fuente para el evento |
|
||||
| `dateHappened` | number | No | Marca de tiempo Unix cuando ocurrió el evento (por defecto: ahora) |
|
||||
| `apiKey` | string | Sí | Clave API de Datadog |
|
||||
| `site` | string | No | Sitio/región de Datadog (predeterminado: datadoghq.com) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `event` | object | Los detalles del evento creado |
|
||||
|
||||
### `datadog_create_monitor`
|
||||
|
||||
Crear un nuevo monitor/alerta en Datadog. Los monitores pueden rastrear métricas, verificaciones de servicio, eventos y más.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `name` | string | Sí | Nombre del monitor |
|
||||
| `type` | string | Sí | Tipo de monitor: alerta de métrica, verificación de servicio, alerta de evento, alerta de proceso, alerta de registro, alerta de consulta, compuesto, alerta de sintéticos, alerta de slo |
|
||||
| `query` | string | Sí | Consulta del monitor \(p. ej., "avg\(last_5m\):avg:system.cpu.idle\{*\} < 20"\) |
|
||||
| `message` | string | No | Mensaje para incluir con las notificaciones. Puede incluir menciones con @ y markdown. |
|
||||
| `tags` | string | No | Lista de etiquetas separadas por comas |
|
||||
| `priority` | number | No | Prioridad del monitor \(1-5, donde 1 es la más alta\) |
|
||||
| `options` | string | No | Cadena JSON de opciones del monitor \(umbrales, notify_no_data, renotify_interval, etc.\) |
|
||||
| `apiKey` | string | Sí | Clave API de Datadog |
|
||||
| `applicationKey` | string | Sí | Clave de aplicación de Datadog |
|
||||
| `site` | string | No | Sitio/región de Datadog \(predeterminado: datadoghq.com\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `monitor` | object | Los detalles del monitor creado |
|
||||
|
||||
### `datadog_get_monitor`
|
||||
|
||||
Recuperar detalles de un monitor específico por ID.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `monitorId` | string | Sí | El ID del monitor a recuperar |
|
||||
| `groupStates` | string | No | Estados de grupo separados por comas para incluir: alerta, advertencia, sin datos, ok |
|
||||
| `withDowntimes` | boolean | No | Incluir datos de tiempo de inactividad con el monitor |
|
||||
| `apiKey` | string | Sí | Clave API de Datadog |
|
||||
| `applicationKey` | string | Sí | Clave de aplicación de Datadog |
|
||||
| `site` | string | No | Sitio/región de Datadog \(predeterminado: datadoghq.com\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `monitor` | object | Los detalles del monitor |
|
||||
|
||||
### `datadog_list_monitors`
|
||||
|
||||
Lista todos los monitores en Datadog con filtrado opcional por nombre, etiquetas o estado.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `groupStates` | string | No | Estados de grupo separados por comas para filtrar: alert, warn, no data, ok |
|
||||
| `name` | string | No | Filtrar monitores por nombre \(coincidencia parcial\) |
|
||||
| `tags` | string | No | Lista de etiquetas separadas por comas para filtrar |
|
||||
| `monitorTags` | string | No | Lista de etiquetas de monitor separadas por comas para filtrar |
|
||||
| `withDowntimes` | boolean | No | Incluir datos de tiempo de inactividad con los monitores |
|
||||
| `page` | number | No | Número de página para paginación \(indexado desde 0\) |
|
||||
| `pageSize` | number | No | Número de monitores por página \(máximo 1000\) |
|
||||
| `apiKey` | string | Sí | Clave API de Datadog |
|
||||
| `applicationKey` | string | Sí | Clave de aplicación de Datadog |
|
||||
| `site` | string | No | Sitio/región de Datadog \(predeterminado: datadoghq.com\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `monitors` | array | Lista de monitores |
|
||||
|
||||
### `datadog_mute_monitor`
|
||||
|
||||
Silencia un monitor para suprimir temporalmente las notificaciones.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `monitorId` | string | Sí | El ID del monitor a silenciar |
|
||||
| `scope` | string | No | Ámbito a silenciar \(p. ej., "host:myhost"\). Si no se especifica, silencia todos los ámbitos. |
|
||||
| `end` | number | No | Marca de tiempo Unix cuando debe finalizar el silenciamiento. Si no se especifica, silencia indefinidamente. |
|
||||
| `apiKey` | string | Sí | Clave API de Datadog |
|
||||
| `applicationKey` | string | Sí | Clave de aplicación de Datadog |
|
||||
| `site` | string | No | Sitio/región de Datadog \(predeterminado: datadoghq.com\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Indica si el monitor se silenció correctamente |
|
||||
|
||||
### `datadog_query_logs`
|
||||
|
||||
Busca y recupera registros desde Datadog. Útil para solución de problemas, análisis o monitoreo.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Sí | Consulta de búsqueda de registros \(p. ej., "service:web-app status:error"\) |
|
||||
| `from` | string | Sí | Hora de inicio en formato ISO-8601 o relativo \(p. ej., "now-1h"\) |
|
||||
| `to` | string | Sí | Hora de fin en formato ISO-8601 o relativo \(p. ej., "now"\) |
|
||||
| `limit` | number | No | Número máximo de registros a devolver \(predeterminado: 50, máx: 1000\) |
|
||||
| `sort` | string | No | Orden de clasificación: timestamp \(más antiguos primero\) o -timestamp \(más recientes primero\) |
|
||||
| `indexes` | string | No | Lista separada por comas de índices de registros para buscar |
|
||||
| `apiKey` | string | Sí | Clave API de Datadog |
|
||||
| `applicationKey` | string | Sí | Clave de aplicación de Datadog |
|
||||
| `site` | string | No | Sitio/región de Datadog \(predeterminado: datadoghq.com\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `logs` | array | Lista de entradas de registro |
|
||||
|
||||
### `datadog_send_logs`
|
||||
|
||||
Envía entradas de registro a Datadog para registro centralizado y análisis.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `logs` | string | Sí | Array JSON de entradas de registro. Cada entrada debe tener message y opcionalmente ddsource, ddtags, hostname, service. |
|
||||
| `apiKey` | string | Sí | Clave API de Datadog |
|
||||
| `site` | string | No | Sitio/región de Datadog \(predeterminado: datadoghq.com\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Indica si los registros se enviaron correctamente |
|
||||
|
||||
### `datadog_create_downtime`
|
||||
|
||||
Programa un tiempo de inactividad para suprimir las notificaciones del monitor durante las ventanas de mantenimiento.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `scope` | string | Sí | Ámbito para aplicar el tiempo de inactividad \(p. ej., "host:myhost", "env:production", o "*" para todos\) |
|
||||
| `message` | string | No | Mensaje a mostrar durante el tiempo de inactividad |
|
||||
| `start` | number | No | Marca de tiempo Unix para el inicio del tiempo de inactividad \(por defecto es ahora\) |
|
||||
| `end` | number | No | Marca de tiempo Unix para el final del tiempo de inactividad |
|
||||
| `timezone` | string | No | Zona horaria para el tiempo de inactividad \(p. ej., "America/New_York"\) |
|
||||
| `monitorId` | string | No | ID específico del monitor a silenciar |
|
||||
| `monitorTags` | string | No | Etiquetas de monitor separadas por comas para coincidir \(p. ej., "team:backend,priority:high"\) |
|
||||
| `muteFirstRecoveryNotification` | boolean | No | Silenciar la primera notificación de recuperación |
|
||||
| `apiKey` | string | Sí | Clave API de Datadog |
|
||||
| `applicationKey` | string | Sí | Clave de aplicación de Datadog |
|
||||
| `site` | string | No | Sitio/región de Datadog \(por defecto: datadoghq.com\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `downtime` | object | Los detalles del tiempo de inactividad creado |
|
||||
|
||||
### `datadog_list_downtimes`
|
||||
|
||||
Listar todos los tiempos de inactividad programados en Datadog.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `currentOnly` | boolean | No | Solo devolver tiempos de inactividad actualmente activos |
|
||||
| `monitorId` | string | No | Filtrar por ID de monitor |
|
||||
| `apiKey` | string | Sí | Clave API de Datadog |
|
||||
| `applicationKey` | string | Sí | Clave de aplicación de Datadog |
|
||||
| `site` | string | No | Sitio/región de Datadog \(por defecto: datadoghq.com\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `downtimes` | array | Lista de tiempos de inactividad |
|
||||
|
||||
### `datadog_cancel_downtime`
|
||||
|
||||
Cancelar un tiempo de inactividad programado.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `downtimeId` | string | Sí | El ID del tiempo de inactividad a cancelar |
|
||||
| `apiKey` | string | Sí | Clave API de Datadog |
|
||||
| `applicationKey` | string | Sí | Clave de aplicación de Datadog |
|
||||
| `site` | string | No | Sitio/región de Datadog (predeterminado: datadoghq.com) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Indica si el tiempo de inactividad se canceló correctamente |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `datadog`
|
||||
219
apps/docs/content/docs/es/tools/dropbox.mdx
Normal file
219
apps/docs/content/docs/es/tools/dropbox.mdx
Normal file
@@ -0,0 +1,219 @@
|
||||
---
|
||||
title: Dropbox
|
||||
description: Sube, descarga, comparte y gestiona archivos en Dropbox
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="dropbox"
|
||||
color="#0061FF"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Dropbox](https://dropbox.com/) es una popular plataforma de almacenamiento en la nube y colaboración que permite a individuos y equipos almacenar, acceder y compartir archivos de forma segura desde cualquier lugar. Dropbox está diseñado para facilitar la gestión de archivos, la sincronización y una potente colaboración, ya sea que trabajes solo o en grupo.
|
||||
|
||||
Con Dropbox en Sim, puedes:
|
||||
|
||||
- **Subir y descargar archivos**: Sube cualquier archivo a tu Dropbox o recupera contenido bajo demanda sin problemas
|
||||
- **Listar contenidos de carpetas**: Navega por los archivos y carpetas dentro de cualquier directorio de Dropbox
|
||||
- **Crear nuevas carpetas**: Organiza tus archivos creando programáticamente nuevas carpetas en tu Dropbox
|
||||
- **Buscar archivos y carpetas**: Localiza documentos, imágenes u otros elementos por nombre o contenido
|
||||
- **Generar enlaces compartidos**: Crea rápidamente enlaces públicos o privados compartibles para archivos y carpetas
|
||||
- **Gestionar archivos**: Mueve, elimina o renombra archivos y carpetas como parte de flujos de trabajo automatizados
|
||||
|
||||
Estas capacidades permiten a tus agentes Sim automatizar operaciones de Dropbox directamente dentro de tus flujos de trabajo — desde hacer copias de seguridad de archivos importantes hasta distribuir contenido y mantener carpetas organizadas. Usa Dropbox como fuente y destino para archivos, permitiendo una gestión fluida del almacenamiento en la nube como parte de tus procesos de negocio.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra Dropbox en tu flujo de trabajo para la gestión de archivos, compartir y colaboración. Sube archivos, descarga contenido, crea carpetas, gestiona enlaces compartidos y más.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `dropbox_upload`
|
||||
|
||||
Subir un archivo a Dropbox
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Sí | La ruta en Dropbox donde se guardará el archivo \(p. ej., /carpeta/documento.pdf\) |
|
||||
| `fileContent` | string | Sí | El contenido codificado en base64 del archivo a subir |
|
||||
| `fileName` | string | No | Nombre de archivo opcional \(usado si la ruta es una carpeta\) |
|
||||
| `mode` | string | No | Modo de escritura: add \(predeterminado\) u overwrite |
|
||||
| `autorename` | boolean | No | Si es true, renombra el archivo si hay un conflicto |
|
||||
| `mute` | boolean | No | Si es true, no notifica al usuario sobre esta subida |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | object | Los metadatos del archivo subido |
|
||||
|
||||
### `dropbox_download`
|
||||
|
||||
Descargar un archivo de Dropbox y obtener un enlace temporal
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Sí | La ruta del archivo a descargar \(p. ej., /carpeta/documento.pdf\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `file` | object | Los metadatos del archivo |
|
||||
|
||||
### `dropbox_list_folder`
|
||||
|
||||
Listar el contenido de una carpeta en Dropbox
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Sí | La ruta de la carpeta a listar \(usar "" para la raíz\) |
|
||||
| `recursive` | boolean | No | Si es verdadero, lista el contenido recursivamente |
|
||||
| `includeDeleted` | boolean | No | Si es verdadero, incluye archivos/carpetas eliminados |
|
||||
| `includeMediaInfo` | boolean | No | Si es verdadero, incluye información multimedia para fotos/videos |
|
||||
| `limit` | number | No | Número máximo de resultados a devolver \(predeterminado: 500\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `entries` | array | Lista de archivos y carpetas en el directorio |
|
||||
|
||||
### `dropbox_create_folder`
|
||||
|
||||
Crear una nueva carpeta en Dropbox
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Sí | La ruta donde se debe crear la carpeta \(p. ej., /nueva-carpeta\) |
|
||||
| `autorename` | boolean | No | Si es verdadero, renombra la carpeta si hay un conflicto |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `folder` | objeto | Los metadatos de la carpeta creada |
|
||||
|
||||
### `dropbox_delete`
|
||||
|
||||
Eliminar un archivo o carpeta en Dropbox (mueve a la papelera)
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | cadena | Sí | La ruta del archivo o carpeta a eliminar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | objeto | Metadatos del elemento eliminado |
|
||||
|
||||
### `dropbox_copy`
|
||||
|
||||
Copiar un archivo o carpeta en Dropbox
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `fromPath` | cadena | Sí | La ruta de origen del archivo o carpeta a copiar |
|
||||
| `toPath` | cadena | Sí | La ruta de destino para el archivo o carpeta copiado |
|
||||
| `autorename` | booleano | No | Si es verdadero, renombra el archivo si hay un conflicto en el destino |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | objeto | Metadatos del elemento copiado |
|
||||
|
||||
### `dropbox_move`
|
||||
|
||||
Mover o renombrar un archivo o carpeta en Dropbox
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `fromPath` | cadena | Sí | La ruta de origen del archivo o carpeta a mover |
|
||||
| `toPath` | cadena | Sí | La ruta de destino para el archivo o carpeta movido |
|
||||
| `autorename` | booleano | No | Si es verdadero, renombra el archivo si hay un conflicto en el destino |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadatos del elemento movido |
|
||||
|
||||
### `dropbox_get_metadata`
|
||||
|
||||
Obtener metadatos de un archivo o carpeta en Dropbox
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Sí | La ruta del archivo o carpeta del que obtener metadatos |
|
||||
| `includeMediaInfo` | boolean | No | Si es verdadero, incluye información multimedia para fotos/videos |
|
||||
| `includeDeleted` | boolean | No | Si es verdadero, incluye archivos eliminados en los resultados |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `metadata` | object | Metadatos del archivo o carpeta |
|
||||
|
||||
### `dropbox_create_shared_link`
|
||||
|
||||
Crear un enlace compartible para un archivo o carpeta en Dropbox
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `path` | string | Sí | La ruta del archivo o carpeta a compartir |
|
||||
| `requestedVisibility` | string | No | Visibilidad: public, team_only, o password |
|
||||
| `linkPassword` | string | No | Contraseña para el enlace compartido \(solo si la visibilidad es password\) |
|
||||
| `expires` | string | No | Fecha de caducidad en formato ISO 8601 \(p. ej., 2025-12-31T23:59:59Z\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `sharedLink` | object | El enlace compartido creado |
|
||||
|
||||
### `dropbox_search`
|
||||
|
||||
Buscar archivos y carpetas en Dropbox
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `query` | string | Sí | La consulta de búsqueda |
|
||||
| `path` | string | No | Limitar la búsqueda a una ruta de carpeta específica |
|
||||
| `fileExtensions` | string | No | Lista separada por comas de extensiones de archivo para filtrar \(p. ej., pdf,xlsx\) |
|
||||
| `maxResults` | number | No | Número máximo de resultados a devolver \(predeterminado: 100\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `matches` | array | Resultados de la búsqueda |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `dropbox`
|
||||
188
apps/docs/content/docs/es/tools/dynamodb.mdx
Normal file
188
apps/docs/content/docs/es/tools/dynamodb.mdx
Normal file
@@ -0,0 +1,188 @@
|
||||
---
|
||||
title: Amazon DynamoDB
|
||||
description: Conectar a Amazon DynamoDB
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="dynamodb"
|
||||
color="linear-gradient(45deg, #2E27AD 0%, #527FFF 100%)"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Amazon DynamoDB](https://aws.amazon.com/dynamodb/) es un servicio de base de datos NoSQL completamente administrado ofrecido por AWS que proporciona un rendimiento rápido y predecible con escalabilidad perfecta. DynamoDB te permite almacenar y recuperar cualquier cantidad de datos y atender cualquier nivel de tráfico de solicitudes, sin necesidad de administrar hardware o infraestructura.
|
||||
|
||||
Con DynamoDB, puedes:
|
||||
|
||||
- **Obtener elementos**: Buscar elementos en tus tablas usando claves primarias
|
||||
- **Poner elementos**: Añadir o reemplazar elementos en tus tablas
|
||||
- **Consultar elementos**: Recuperar múltiples elementos usando consultas a través de índices
|
||||
- **Escanear tablas**: Leer todos o parte de los datos en una tabla
|
||||
- **Actualizar elementos**: Modificar atributos específicos de elementos existentes
|
||||
- **Eliminar elementos**: Eliminar registros de tus tablas
|
||||
|
||||
En Sim, la integración con DynamoDB permite a tus agentes acceder y manipular de forma segura las tablas de DynamoDB utilizando credenciales de AWS. Las operaciones compatibles incluyen:
|
||||
|
||||
- **Get**: Recuperar un elemento por su clave
|
||||
- **Put**: Insertar o sobrescribir elementos
|
||||
- **Query**: Ejecutar consultas utilizando condiciones de clave y filtros
|
||||
- **Scan**: Leer múltiples elementos escaneando la tabla o índice
|
||||
- **Update**: Cambiar atributos específicos de uno o más elementos
|
||||
- **Delete**: Eliminar un elemento de una tabla
|
||||
|
||||
Esta integración permite a los agentes de Sim automatizar tareas de gestión de datos dentro de tus tablas de DynamoDB de forma programática, para que puedas crear flujos de trabajo que gestionen, modifiquen y recuperen datos NoSQL escalables sin esfuerzo manual ni gestión de servidores.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra Amazon DynamoDB en flujos de trabajo. Compatible con operaciones Get, Put, Query, Scan, Update y Delete en tablas de DynamoDB.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `dynamodb_get`
|
||||
|
||||
Obtener un elemento de una tabla DynamoDB mediante clave primaria
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Sí | Región de AWS \(p. ej., us-east-1\) |
|
||||
| `accessKeyId` | string | Sí | ID de clave de acceso de AWS |
|
||||
| `secretAccessKey` | string | Sí | Clave de acceso secreta de AWS |
|
||||
| `tableName` | string | Sí | Nombre de la tabla DynamoDB |
|
||||
| `key` | object | Sí | Clave primaria del elemento a recuperar |
|
||||
| `consistentRead` | boolean | No | Usar lectura fuertemente consistente |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
| `item` | object | Elemento recuperado |
|
||||
|
||||
### `dynamodb_put`
|
||||
|
||||
Poner un elemento en una tabla DynamoDB
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Sí | Región de AWS \(p. ej., us-east-1\) |
|
||||
| `accessKeyId` | string | Sí | ID de clave de acceso de AWS |
|
||||
| `secretAccessKey` | string | Sí | Clave de acceso secreta de AWS |
|
||||
| `tableName` | string | Sí | Nombre de la tabla DynamoDB |
|
||||
| `item` | object | Sí | Elemento a poner en la tabla |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
| `item` | object | Elemento creado |
|
||||
|
||||
### `dynamodb_query`
|
||||
|
||||
Consultar elementos de una tabla DynamoDB usando condiciones de clave
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Sí | Región de AWS \(p. ej., us-east-1\) |
|
||||
| `accessKeyId` | string | Sí | ID de clave de acceso de AWS |
|
||||
| `secretAccessKey` | string | Sí | Clave de acceso secreta de AWS |
|
||||
| `tableName` | string | Sí | Nombre de la tabla DynamoDB |
|
||||
| `keyConditionExpression` | string | Sí | Expresión de condición de clave \(p. ej., "pk = :pk"\) |
|
||||
| `filterExpression` | string | No | Expresión de filtro para resultados |
|
||||
| `expressionAttributeNames` | object | No | Mapeos de nombres de atributos para palabras reservadas |
|
||||
| `expressionAttributeValues` | object | No | Valores de atributos de expresión |
|
||||
| `indexName` | string | No | Nombre del índice secundario para consultar |
|
||||
| `limit` | number | No | Número máximo de elementos a devolver |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
| `items` | array | Array de elementos devueltos |
|
||||
| `count` | number | Número de elementos devueltos |
|
||||
|
||||
### `dynamodb_scan`
|
||||
|
||||
Escanear todos los elementos en una tabla DynamoDB
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Sí | Región de AWS \(p. ej., us-east-1\) |
|
||||
| `accessKeyId` | string | Sí | ID de clave de acceso de AWS |
|
||||
| `secretAccessKey` | string | Sí | Clave de acceso secreta de AWS |
|
||||
| `tableName` | string | Sí | Nombre de la tabla DynamoDB |
|
||||
| `filterExpression` | string | No | Expresión de filtro para resultados |
|
||||
| `projectionExpression` | string | No | Atributos a recuperar |
|
||||
| `expressionAttributeNames` | object | No | Mapeos de nombres de atributos para palabras reservadas |
|
||||
| `expressionAttributeValues` | object | No | Valores de atributos de expresión |
|
||||
| `limit` | number | No | Número máximo de elementos a devolver |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
| `items` | array | Array de elementos devueltos |
|
||||
| `count` | number | Número de elementos devueltos |
|
||||
|
||||
### `dynamodb_update`
|
||||
|
||||
Actualizar un elemento en una tabla de DynamoDB
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Sí | Región de AWS \(p. ej., us-east-1\) |
|
||||
| `accessKeyId` | string | Sí | ID de clave de acceso de AWS |
|
||||
| `secretAccessKey` | string | Sí | Clave de acceso secreta de AWS |
|
||||
| `tableName` | string | Sí | Nombre de la tabla de DynamoDB |
|
||||
| `key` | object | Sí | Clave primaria del elemento a actualizar |
|
||||
| `updateExpression` | string | Sí | Expresión de actualización \(p. ej., "SET #name = :name"\) |
|
||||
| `expressionAttributeNames` | object | No | Mapeos de nombres de atributos para palabras reservadas |
|
||||
| `expressionAttributeValues` | object | No | Valores de atributos de expresión |
|
||||
| `conditionExpression` | string | No | Condición que debe cumplirse para que la actualización tenga éxito |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
| `item` | object | Elemento actualizado |
|
||||
|
||||
### `dynamodb_delete`
|
||||
|
||||
Eliminar un elemento de una tabla de DynamoDB
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Sí | Región de AWS \(p. ej., us-east-1\) |
|
||||
| `accessKeyId` | string | Sí | ID de clave de acceso de AWS |
|
||||
| `secretAccessKey` | string | Sí | Clave de acceso secreta de AWS |
|
||||
| `tableName` | string | Sí | Nombre de la tabla de DynamoDB |
|
||||
| `key` | object | Sí | Clave primaria del elemento a eliminar |
|
||||
| `conditionExpression` | string | No | Condición que debe cumplirse para que la eliminación tenga éxito |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `dynamodb`
|
||||
365
apps/docs/content/docs/es/tools/elasticsearch.mdx
Normal file
365
apps/docs/content/docs/es/tools/elasticsearch.mdx
Normal file
@@ -0,0 +1,365 @@
|
||||
---
|
||||
title: Elasticsearch
|
||||
description: Busca, indexa y gestiona datos en Elasticsearch
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="elasticsearch"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Elasticsearch](https://www.elastic.co/elasticsearch/) es un potente motor de búsqueda y análisis distribuido que te permite indexar, buscar y analizar grandes volúmenes de datos en tiempo real. Es ampliamente utilizado para potenciar funciones de búsqueda, análisis de datos de registros y eventos, observabilidad y más.
|
||||
|
||||
Con Elasticsearch en Sim, obtienes acceso programático a las capacidades principales de Elasticsearch, incluyendo:
|
||||
|
||||
- **Búsqueda de documentos**: Realiza búsquedas avanzadas en texto estructurado o no estructurado utilizando Query DSL, con soporte para ordenación, paginación y selección de campos.
|
||||
- **Indexación de documentos**: Añade nuevos documentos o actualiza los existentes en cualquier índice de Elasticsearch para su recuperación y análisis inmediatos.
|
||||
- **Obtener, actualizar o eliminar documentos**: Recupera, modifica o elimina documentos específicos por ID.
|
||||
- **Operaciones masivas**: Ejecuta múltiples acciones de indexación o actualización en una sola solicitud para un procesamiento de datos de alto rendimiento.
|
||||
- **Gestión de índices**: Crea, elimina u obtén detalles sobre índices como parte de tu automatización de flujo de trabajo.
|
||||
- **Monitorización de clústeres**: Comprueba la salud y las estadísticas de tu despliegue de Elasticsearch.
|
||||
|
||||
Las herramientas de Elasticsearch de Sim funcionan tanto con entornos autoalojados como con Elastic Cloud. Integra Elasticsearch en tus flujos de trabajo de agentes para automatizar la ingesta de datos, buscar en vastos conjuntos de datos, ejecutar informes o construir aplicaciones personalizadas basadas en búsquedas, todo sin intervención manual.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra Elasticsearch en flujos de trabajo para búsquedas potentes, indexación y gestión de datos. Admite operaciones CRUD de documentos, consultas de búsqueda avanzadas, operaciones masivas, gestión de índices y monitorización de clústeres. Funciona tanto con despliegues autoalojados como con Elastic Cloud.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `elasticsearch_search`
|
||||
|
||||
Busca documentos en Elasticsearch usando Query DSL. Devuelve documentos coincidentes con puntuaciones y metadatos.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `deploymentType` | string | Sí | Tipo de despliegue: self_hosted o cloud |
|
||||
| `host` | string | No | URL del host de Elasticsearch (para self-hosted) |
|
||||
| `cloudId` | string | No | ID de Elastic Cloud (para despliegues en la nube) |
|
||||
| `authMethod` | string | Sí | Método de autenticación: api_key o basic_auth |
|
||||
| `apiKey` | string | No | Clave API de Elasticsearch |
|
||||
| `username` | string | No | Nombre de usuario para autenticación básica |
|
||||
| `password` | string | No | Contraseña para autenticación básica |
|
||||
| `index` | string | Sí | Nombre del índice para buscar |
|
||||
| `query` | string | No | Query DSL como cadena JSON |
|
||||
| `from` | number | No | Desplazamiento inicial para paginación (predeterminado: 0) |
|
||||
| `size` | number | No | Número de resultados a devolver (predeterminado: 10) |
|
||||
| `sort` | string | No | Especificación de ordenación como cadena JSON |
|
||||
| `sourceIncludes` | string | No | Lista separada por comas de campos a incluir en _source |
|
||||
| `sourceExcludes` | string | No | Lista separada por comas de campos a excluir de _source |
|
||||
| `trackTotalHits` | boolean | No | Seguimiento preciso del recuento total de coincidencias (predeterminado: true) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `took` | number | Tiempo en milisegundos que tardó la búsqueda |
|
||||
| `timed_out` | boolean | Si la búsqueda agotó el tiempo de espera |
|
||||
| `hits` | object | Resultados de búsqueda con recuento total y documentos coincidentes |
|
||||
| `aggregations` | json | Resultados de agregación si los hay |
|
||||
|
||||
### `elasticsearch_index_document`
|
||||
|
||||
Indexar (crear o actualizar) un documento en Elasticsearch.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Sí | Tipo de despliegue: self_hosted o cloud |
|
||||
| `host` | string | No | URL del host de Elasticsearch \(para self-hosted\) |
|
||||
| `cloudId` | string | No | ID de Elastic Cloud \(para despliegues en cloud\) |
|
||||
| `authMethod` | string | Sí | Método de autenticación: api_key o basic_auth |
|
||||
| `apiKey` | string | No | Clave API de Elasticsearch |
|
||||
| `username` | string | No | Nombre de usuario para autenticación básica |
|
||||
| `password` | string | No | Contraseña para autenticación básica |
|
||||
| `index` | string | Sí | Nombre del índice de destino |
|
||||
| `documentId` | string | No | ID del documento \(se genera automáticamente si no se proporciona\) |
|
||||
| `document` | string | Sí | Cuerpo del documento como cadena JSON |
|
||||
| `refresh` | string | No | Política de actualización: true, false o wait_for |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `_index` | string | Índice donde se almacenó el documento |
|
||||
| `_id` | string | ID del documento |
|
||||
| `_version` | number | Versión del documento |
|
||||
| `result` | string | Resultado de la operación \(created o updated\) |
|
||||
|
||||
### `elasticsearch_get_document`
|
||||
|
||||
Recuperar un documento por ID desde Elasticsearch.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Sí | Tipo de despliegue: self_hosted o cloud |
|
||||
| `host` | string | No | URL del host de Elasticsearch \(para self-hosted\) |
|
||||
| `cloudId` | string | No | ID de Elastic Cloud \(para despliegues en cloud\) |
|
||||
| `authMethod` | string | Sí | Método de autenticación: api_key o basic_auth |
|
||||
| `apiKey` | string | No | Clave API de Elasticsearch |
|
||||
| `username` | string | No | Nombre de usuario para autenticación básica |
|
||||
| `password` | string | No | Contraseña para autenticación básica |
|
||||
| `index` | string | Sí | Nombre del índice |
|
||||
| `documentId` | string | Sí | ID del documento a recuperar |
|
||||
| `sourceIncludes` | string | No | Lista separada por comas de campos a incluir |
|
||||
| `sourceExcludes` | string | No | Lista separada por comas de campos a excluir |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `_index` | string | Nombre del índice |
|
||||
| `_id` | string | ID del documento |
|
||||
| `_version` | number | Versión del documento |
|
||||
| `found` | boolean | Si el documento fue encontrado |
|
||||
| `_source` | json | Contenido del documento |
|
||||
|
||||
### `elasticsearch_update_document`
|
||||
|
||||
Actualiza parcialmente un documento en Elasticsearch usando la fusión de documentos.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Sí | Tipo de despliegue: self_hosted o cloud |
|
||||
| `host` | string | No | URL del host de Elasticsearch (para self-hosted) |
|
||||
| `cloudId` | string | No | ID de Elastic Cloud (para despliegues en la nube) |
|
||||
| `authMethod` | string | Sí | Método de autenticación: api_key o basic_auth |
|
||||
| `apiKey` | string | No | Clave API de Elasticsearch |
|
||||
| `username` | string | No | Nombre de usuario para autenticación básica |
|
||||
| `password` | string | No | Contraseña para autenticación básica |
|
||||
| `index` | string | Sí | Nombre del índice |
|
||||
| `documentId` | string | Sí | ID del documento a actualizar |
|
||||
| `document` | string | Sí | Documento parcial para fusionar como cadena JSON |
|
||||
| `retryOnConflict` | number | No | Número de reintentos en conflicto de versión |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `_index` | string | Nombre del índice |
|
||||
| `_id` | string | ID del documento |
|
||||
| `_version` | number | Nueva versión del documento |
|
||||
| `result` | string | Resultado de la operación (updated o noop) |
|
||||
|
||||
### `elasticsearch_delete_document`
|
||||
|
||||
Elimina un documento de Elasticsearch por ID.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Sí | Tipo de despliegue: self_hosted o cloud |
|
||||
| `host` | string | No | URL del host de Elasticsearch \(para self-hosted\) |
|
||||
| `cloudId` | string | No | ID de Elastic Cloud \(para despliegues en la nube\) |
|
||||
| `authMethod` | string | Sí | Método de autenticación: api_key o basic_auth |
|
||||
| `apiKey` | string | No | Clave API de Elasticsearch |
|
||||
| `username` | string | No | Nombre de usuario para autenticación básica |
|
||||
| `password` | string | No | Contraseña para autenticación básica |
|
||||
| `index` | string | Sí | Nombre del índice |
|
||||
| `documentId` | string | Sí | ID del documento a eliminar |
|
||||
| `refresh` | string | No | Política de actualización: true, false o wait_for |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `_index` | string | Nombre del índice |
|
||||
| `_id` | string | ID del documento |
|
||||
| `_version` | number | Versión del documento |
|
||||
| `result` | string | Resultado de la operación \(deleted o not_found\) |
|
||||
|
||||
### `elasticsearch_bulk`
|
||||
|
||||
Realiza múltiples operaciones de indexación, creación, eliminación o actualización en una sola petición para un alto rendimiento.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Sí | Tipo de despliegue: self_hosted o cloud |
|
||||
| `host` | string | No | URL del host de Elasticsearch \(para self-hosted\) |
|
||||
| `cloudId` | string | No | ID de Elastic Cloud \(para despliegues en la nube\) |
|
||||
| `authMethod` | string | Sí | Método de autenticación: api_key o basic_auth |
|
||||
| `apiKey` | string | No | Clave API de Elasticsearch |
|
||||
| `username` | string | No | Nombre de usuario para autenticación básica |
|
||||
| `password` | string | No | Contraseña para autenticación básica |
|
||||
| `index` | string | No | Índice predeterminado para operaciones que no especifican uno |
|
||||
| `operations` | string | Sí | Operaciones masivas como cadena NDJSON \(JSON delimitado por nuevas líneas\) |
|
||||
| `refresh` | string | No | Política de actualización: true, false o wait_for |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `took` | number | Tiempo en milisegundos que tardó la operación masiva |
|
||||
| `errors` | boolean | Si alguna operación tuvo un error |
|
||||
| `items` | array | Resultados para cada operación |
|
||||
|
||||
### `elasticsearch_count`
|
||||
|
||||
Contar documentos que coinciden con una consulta en Elasticsearch.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Sí | Tipo de despliegue: self_hosted o cloud |
|
||||
| `host` | string | No | URL del host de Elasticsearch \(para self-hosted\) |
|
||||
| `cloudId` | string | No | ID de Elastic Cloud \(para despliegues en la nube\) |
|
||||
| `authMethod` | string | Sí | Método de autenticación: api_key o basic_auth |
|
||||
| `apiKey` | string | No | Clave API de Elasticsearch |
|
||||
| `username` | string | No | Nombre de usuario para autenticación básica |
|
||||
| `password` | string | No | Contraseña para autenticación básica |
|
||||
| `index` | string | Sí | Nombre del índice donde contar documentos |
|
||||
| `query` | string | No | Consulta opcional para filtrar documentos \(cadena JSON\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `count` | number | Número de documentos que coinciden con la consulta |
|
||||
| `_shards` | object | Estadísticas de fragmentos |
|
||||
|
||||
### `elasticsearch_create_index`
|
||||
|
||||
Crear un nuevo índice con configuraciones y mapeos opcionales.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Sí | Tipo de despliegue: self_hosted o cloud |
|
||||
| `host` | string | No | URL del host de Elasticsearch \(para self-hosted\) |
|
||||
| `cloudId` | string | No | ID de Elastic Cloud \(para despliegues en la nube\) |
|
||||
| `authMethod` | string | Sí | Método de autenticación: api_key o basic_auth |
|
||||
| `apiKey` | string | No | Clave API de Elasticsearch |
|
||||
| `username` | string | No | Nombre de usuario para autenticación básica |
|
||||
| `password` | string | No | Contraseña para autenticación básica |
|
||||
| `index` | string | Sí | Nombre del índice a crear |
|
||||
| `settings` | string | No | Configuraciones del índice como cadena JSON |
|
||||
| `mappings` | string | No | Mapeos del índice como cadena JSON |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `acknowledged` | boolean | Si la solicitud fue reconocida |
|
||||
| `shards_acknowledged` | boolean | Si los fragmentos fueron reconocidos |
|
||||
| `index` | string | Nombre del índice creado |
|
||||
|
||||
### `elasticsearch_delete_index`
|
||||
|
||||
Elimina un índice y todos sus documentos. Esta operación es irreversible.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Sí | Tipo de despliegue: self_hosted o cloud |
|
||||
| `host` | string | No | URL del host de Elasticsearch \(para self-hosted\) |
|
||||
| `cloudId` | string | No | ID de Elastic Cloud \(para despliegues en la nube\) |
|
||||
| `authMethod` | string | Sí | Método de autenticación: api_key o basic_auth |
|
||||
| `apiKey` | string | No | Clave API de Elasticsearch |
|
||||
| `username` | string | No | Nombre de usuario para autenticación básica |
|
||||
| `password` | string | No | Contraseña para autenticación básica |
|
||||
| `index` | string | Sí | Nombre del índice a eliminar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `acknowledged` | boolean | Si la eliminación fue reconocida |
|
||||
|
||||
### `elasticsearch_get_index`
|
||||
|
||||
Recupera información del índice incluyendo configuraciones, mapeos y alias.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Sí | Tipo de despliegue: self_hosted o cloud |
|
||||
| `host` | string | No | URL del host de Elasticsearch \(para self-hosted\) |
|
||||
| `cloudId` | string | No | ID de Elastic Cloud \(para despliegues en la nube\) |
|
||||
| `authMethod` | string | Sí | Método de autenticación: api_key o basic_auth |
|
||||
| `apiKey` | string | No | Clave API de Elasticsearch |
|
||||
| `username` | string | No | Nombre de usuario para autenticación básica |
|
||||
| `password` | string | No | Contraseña para autenticación básica |
|
||||
| `index` | string | Sí | Nombre del índice del que recuperar información |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `index` | json | Información del índice incluyendo alias, mapeos y configuraciones |
|
||||
|
||||
### `elasticsearch_cluster_health`
|
||||
|
||||
Obtener el estado de salud del clúster de Elasticsearch.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `deploymentType` | string | Sí | Tipo de despliegue: self_hosted o cloud |
|
||||
| `host` | string | No | URL del host de Elasticsearch \(para self-hosted\) |
|
||||
| `cloudId` | string | No | ID de Elastic Cloud \(para despliegues en la nube\) |
|
||||
| `authMethod` | string | Sí | Método de autenticación: api_key o basic_auth |
|
||||
| `apiKey` | string | No | Clave API de Elasticsearch |
|
||||
| `username` | string | No | Nombre de usuario para autenticación básica |
|
||||
| `password` | string | No | Contraseña para autenticación básica |
|
||||
| `waitForStatus` | string | No | Esperar hasta que el clúster alcance este estado: green, yellow o red |
|
||||
| `timeout` | string | No | Tiempo de espera para la operación de espera \(p. ej., 30s, 1m\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `cluster_name` | string | Nombre del clúster |
|
||||
| `status` | string | Estado de salud del clúster: green, yellow o red |
|
||||
| `number_of_nodes` | number | Número total de nodos en el clúster |
|
||||
| `number_of_data_nodes` | number | Número de nodos de datos |
|
||||
| `active_shards` | number | Número de fragmentos activos |
|
||||
| `unassigned_shards` | number | Número de fragmentos no asignados |
|
||||
|
||||
### `elasticsearch_cluster_stats`
|
||||
|
||||
Obtén estadísticas completas sobre el clúster de Elasticsearch.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `deploymentType` | string | Sí | Tipo de despliegue: self_hosted o cloud |
|
||||
| `host` | string | No | URL del host de Elasticsearch (para self-hosted) |
|
||||
| `cloudId` | string | No | ID de Elastic Cloud (para despliegues en la nube) |
|
||||
| `authMethod` | string | Sí | Método de autenticación: api_key o basic_auth |
|
||||
| `apiKey` | string | No | Clave API de Elasticsearch |
|
||||
| `username` | string | No | Nombre de usuario para autenticación básica |
|
||||
| `password` | string | No | Contraseña para autenticación básica |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `cluster_name` | string | Nombre del clúster |
|
||||
| `status` | string | Estado de salud del clúster |
|
||||
| `nodes` | object | Estadísticas de nodos incluyendo recuento y versiones |
|
||||
| `indices` | object | Estadísticas de índices incluyendo recuento de documentos y tamaño de almacenamiento |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `elasticsearch`
|
||||
429
apps/docs/content/docs/es/tools/gitlab.mdx
Normal file
429
apps/docs/content/docs/es/tools/gitlab.mdx
Normal file
@@ -0,0 +1,429 @@
|
||||
---
|
||||
title: GitLab
|
||||
description: Interactúa con proyectos, issues, solicitudes de fusión y pipelines de GitLab
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="gitlab"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[GitLab](https://gitlab.com/) es una plataforma DevOps integral que permite a los equipos gestionar, colaborar y automatizar su ciclo de vida de desarrollo de software. Con GitLab, puedes manejar sin esfuerzo la gestión del código fuente, CI/CD, revisiones y colaboración en una sola aplicación.
|
||||
|
||||
Con GitLab en Sim, puedes:
|
||||
|
||||
- **Gestionar proyectos y repositorios**: Listar y recuperar tus proyectos de GitLab, acceder a detalles y organizar tus repositorios
|
||||
- **Trabajar con issues**: Listar, crear y comentar issues para realizar seguimiento del trabajo y colaborar eficazmente
|
||||
- **Gestionar solicitudes de fusión**: Revisar, crear y gestionar solicitudes de fusión para cambios de código y revisiones por pares
|
||||
- **Automatizar pipelines de CI/CD**: Activar, monitorear e interactuar con pipelines de GitLab como parte de tus flujos de automatización
|
||||
- **Colaborar con comentarios**: Añadir comentarios a issues o solicitudes de fusión para una comunicación eficiente dentro de tu equipo
|
||||
|
||||
Usando la integración de GitLab en Sim, tus agentes pueden interactuar programáticamente con tus proyectos de GitLab. Automatiza la gestión de proyectos, seguimiento de issues, revisiones de código y operaciones de pipeline de manera fluida en tus flujos de trabajo, optimizando tu proceso de desarrollo de software y mejorando la colaboración en todo tu equipo.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra GitLab en el flujo de trabajo. Puede gestionar proyectos, issues, solicitudes de fusión, pipelines y añadir comentarios. Compatible con todas las operaciones principales de DevOps de GitLab.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `gitlab_list_projects`
|
||||
|
||||
Listar proyectos de GitLab accesibles para el usuario autenticado
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `owned` | boolean | No | Limitar a proyectos propiedad del usuario actual |
|
||||
| `membership` | boolean | No | Limitar a proyectos de los que el usuario actual es miembro |
|
||||
| `search` | string | No | Buscar proyectos por nombre |
|
||||
| `visibility` | string | No | Filtrar por visibilidad \(public, internal, private\) |
|
||||
| `orderBy` | string | No | Ordenar por campo \(id, name, path, created_at, updated_at, last_activity_at\) |
|
||||
| `sort` | string | No | Dirección de ordenación \(asc, desc\) |
|
||||
| `perPage` | number | No | Número de resultados por página \(predeterminado 20, máximo 100\) |
|
||||
| `page` | number | No | Número de página para paginación |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `projects` | array | Lista de proyectos de GitLab |
|
||||
| `total` | number | Número total de proyectos |
|
||||
|
||||
### `gitlab_get_project`
|
||||
|
||||
Obtener detalles de un proyecto específico de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL \(p. ej., "namespace/project"\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `project` | object | Los detalles del proyecto de GitLab |
|
||||
|
||||
### `gitlab_list_issues`
|
||||
|
||||
Listar issues en un proyecto de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `state` | string | No | Filtrar por estado \(opened, closed, all\) |
|
||||
| `labels` | string | No | Lista de nombres de etiquetas separados por comas |
|
||||
| `assigneeId` | number | No | Filtrar por ID de usuario asignado |
|
||||
| `milestoneTitle` | string | No | Filtrar por título de hito |
|
||||
| `search` | string | No | Buscar issues por título y descripción |
|
||||
| `orderBy` | string | No | Ordenar por campo \(created_at, updated_at\) |
|
||||
| `sort` | string | No | Dirección de ordenación \(asc, desc\) |
|
||||
| `perPage` | number | No | Número de resultados por página \(predeterminado 20, máximo 100\) |
|
||||
| `page` | number | No | Número de página para paginación |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issues` | array | Lista de issues de GitLab |
|
||||
| `total` | number | Número total de issues |
|
||||
|
||||
### `gitlab_get_issue`
|
||||
|
||||
Obtener detalles de un issue específico de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `issueIid` | number | Sí | Número del issue dentro del proyecto \(el # mostrado en la interfaz de GitLab\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issue` | object | Los detalles del issue de GitLab |
|
||||
|
||||
### `gitlab_create_issue`
|
||||
|
||||
Crear un nuevo issue en un proyecto de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `title` | string | Sí | Título del issue |
|
||||
| `description` | string | No | Descripción del issue \(Markdown soportado\) |
|
||||
| `labels` | string | No | Lista de nombres de etiquetas separados por comas |
|
||||
| `assigneeIds` | array | No | Array de IDs de usuarios para asignar |
|
||||
| `milestoneId` | number | No | ID del hito para asignar |
|
||||
| `dueDate` | string | No | Fecha de vencimiento en formato AAAA-MM-DD |
|
||||
| `confidential` | boolean | No | Si el issue es confidencial |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issue` | object | El issue de GitLab creado |
|
||||
|
||||
### `gitlab_update_issue`
|
||||
|
||||
Actualizar un issue existente en un proyecto de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `issueIid` | number | Sí | ID interno del issue (IID) |
|
||||
| `title` | string | No | Nuevo título del issue |
|
||||
| `description` | string | No | Nueva descripción del issue (compatible con Markdown) |
|
||||
| `stateEvent` | string | No | Evento de estado (cerrar o reabrir) |
|
||||
| `labels` | string | No | Lista de nombres de etiquetas separados por comas |
|
||||
| `assigneeIds` | array | No | Array de IDs de usuarios para asignar |
|
||||
| `milestoneId` | number | No | ID del hito para asignar |
|
||||
| `dueDate` | string | No | Fecha de vencimiento en formato AAAA-MM-DD |
|
||||
| `confidential` | boolean | No | Si el issue es confidencial |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issue` | object | El issue de GitLab actualizado |
|
||||
|
||||
### `gitlab_delete_issue`
|
||||
|
||||
Eliminar un issue de un proyecto de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `issueIid` | number | Sí | ID interno del issue (IID) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Indica si el issue fue eliminado correctamente |
|
||||
|
||||
### `gitlab_create_issue_note`
|
||||
|
||||
Añadir un comentario a un issue de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `issueIid` | number | Sí | ID interno del issue (IID) |
|
||||
| `body` | string | Sí | Cuerpo del comentario (compatible con Markdown) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `note` | object | El comentario creado |
|
||||
|
||||
### `gitlab_list_merge_requests`
|
||||
|
||||
Listar merge requests en un proyecto de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `state` | string | No | Filtrar por estado (opened, closed, merged, all) |
|
||||
| `labels` | string | No | Lista de nombres de etiquetas separados por comas |
|
||||
| `sourceBranch` | string | No | Filtrar por rama de origen |
|
||||
| `targetBranch` | string | No | Filtrar por rama de destino |
|
||||
| `orderBy` | string | No | Ordenar por campo (created_at, updated_at) |
|
||||
| `sort` | string | No | Dirección de ordenación (asc, desc) |
|
||||
| `perPage` | number | No | Número de resultados por página (predeterminado 20, máximo 100) |
|
||||
| `page` | number | No | Número de página para paginación |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequests` | array | Lista de solicitudes de fusión de GitLab |
|
||||
| `total` | number | Número total de solicitudes de fusión |
|
||||
|
||||
### `gitlab_get_merge_request`
|
||||
|
||||
Obtener detalles de una solicitud de fusión específica de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `mergeRequestIid` | number | Sí | ID interno de la solicitud de fusión \(IID\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequest` | object | Los detalles de la solicitud de fusión de GitLab |
|
||||
|
||||
### `gitlab_create_merge_request`
|
||||
|
||||
Crear una nueva solicitud de fusión en un proyecto de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `sourceBranch` | string | Sí | Nombre de la rama de origen |
|
||||
| `targetBranch` | string | Sí | Nombre de la rama de destino |
|
||||
| `title` | string | Sí | Título de la solicitud de fusión |
|
||||
| `description` | string | No | Descripción de la solicitud de fusión \(Markdown soportado\) |
|
||||
| `labels` | string | No | Lista de nombres de etiquetas separados por comas |
|
||||
| `assigneeIds` | array | No | Array de IDs de usuarios para asignar |
|
||||
| `milestoneId` | number | No | ID del hito para asignar |
|
||||
| `removeSourceBranch` | boolean | No | Eliminar rama de origen después de la fusión |
|
||||
| `squash` | boolean | No | Comprimir commits al fusionar |
|
||||
| `draft` | boolean | No | Marcar como borrador \(trabajo en progreso\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequest` | object | La solicitud de fusión de GitLab creada |
|
||||
|
||||
### `gitlab_update_merge_request`
|
||||
|
||||
Actualizar una solicitud de fusión existente en un proyecto de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `mergeRequestIid` | number | Sí | ID interno de la solicitud de fusión (IID) |
|
||||
| `title` | string | No | Nuevo título de la solicitud de fusión |
|
||||
| `description` | string | No | Nueva descripción de la solicitud de fusión |
|
||||
| `stateEvent` | string | No | Evento de estado (cerrar o reabrir) |
|
||||
| `labels` | string | No | Lista de nombres de etiquetas separados por comas |
|
||||
| `assigneeIds` | array | No | Array de IDs de usuarios para asignar |
|
||||
| `milestoneId` | number | No | ID del hito para asignar |
|
||||
| `targetBranch` | string | No | Nueva rama de destino |
|
||||
| `removeSourceBranch` | boolean | No | Eliminar rama de origen después de la fusión |
|
||||
| `squash` | boolean | No | Comprimir commits al fusionar |
|
||||
| `draft` | boolean | No | Marcar como borrador (trabajo en progreso) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequest` | object | La solicitud de fusión de GitLab actualizada |
|
||||
|
||||
### `gitlab_merge_merge_request`
|
||||
|
||||
Fusionar una solicitud de fusión en un proyecto de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `mergeRequestIid` | number | Sí | ID interno de la solicitud de fusión (IID) |
|
||||
| `mergeCommitMessage` | string | No | Mensaje personalizado para el commit de fusión |
|
||||
| `squashCommitMessage` | string | No | Mensaje personalizado para el commit comprimido |
|
||||
| `squash` | boolean | No | Comprimir commits antes de fusionar |
|
||||
| `shouldRemoveSourceBranch` | boolean | No | Eliminar rama de origen después de la fusión |
|
||||
| `mergeWhenPipelineSucceeds` | boolean | No | Fusionar cuando la pipeline tenga éxito |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `mergeRequest` | object | La solicitud de fusión de GitLab fusionada |
|
||||
|
||||
### `gitlab_create_merge_request_note`
|
||||
|
||||
Añadir un comentario a una solicitud de fusión de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `mergeRequestIid` | number | Sí | ID interno de la solicitud de fusión (IID) |
|
||||
| `body` | string | Sí | Cuerpo del comentario (compatible con Markdown) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `note` | object | El comentario creado |
|
||||
|
||||
### `gitlab_list_pipelines`
|
||||
|
||||
Listar pipelines en un proyecto de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `ref` | string | No | Filtrar por ref (rama o etiqueta) |
|
||||
| `status` | string | No | Filtrar por estado (created, waiting_for_resource, preparing, pending, running, success, failed, canceled, skipped, manual, scheduled) |
|
||||
| `orderBy` | string | No | Ordenar por campo (id, status, ref, updated_at, user_id) |
|
||||
| `sort` | string | No | Dirección de ordenación (asc, desc) |
|
||||
| `perPage` | number | No | Número de resultados por página (predeterminado 20, máximo 100) |
|
||||
| `page` | number | No | Número de página para paginación |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipelines` | array | Lista de pipelines de GitLab |
|
||||
| `total` | number | Número total de pipelines |
|
||||
|
||||
### `gitlab_get_pipeline`
|
||||
|
||||
Obtener detalles de un pipeline específico de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `pipelineId` | number | Sí | ID del pipeline |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipeline` | object | Los detalles del pipeline de GitLab |
|
||||
|
||||
### `gitlab_create_pipeline`
|
||||
|
||||
Activar un nuevo pipeline en un proyecto de GitLab
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `ref` | string | Sí | Rama o etiqueta en la que ejecutar el pipeline |
|
||||
| `variables` | array | No | Array de variables para el pipeline \(cada una con clave, valor y tipo de variable opcional\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipeline` | object | El pipeline de GitLab creado |
|
||||
|
||||
### `gitlab_retry_pipeline`
|
||||
|
||||
Reintentar un pipeline de GitLab fallido
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `pipelineId` | number | Sí | ID del pipeline |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipeline` | objeto | El pipeline de GitLab reintentado |
|
||||
|
||||
### `gitlab_cancel_pipeline`
|
||||
|
||||
Cancelar un pipeline de GitLab en ejecución
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | cadena | Sí | ID del proyecto o ruta codificada en URL |
|
||||
| `pipelineId` | número | Sí | ID del pipeline |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pipeline` | objeto | El pipeline de GitLab cancelado |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `gitlab`
|
||||
494
apps/docs/content/docs/es/tools/grafana.mdx
Normal file
494
apps/docs/content/docs/es/tools/grafana.mdx
Normal file
@@ -0,0 +1,494 @@
|
||||
---
|
||||
title: Grafana
|
||||
description: Interactúa con paneles, alertas y anotaciones de Grafana
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="grafana"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Grafana](https://grafana.com/) es una plataforma líder de código abierto para monitorización, observabilidad y visualización. Permite a los usuarios consultar, visualizar, alertar y analizar datos de diversas fuentes, convirtiéndola en una herramienta esencial para la monitorización de infraestructuras y aplicaciones.
|
||||
|
||||
Con Grafana, puedes:
|
||||
|
||||
- **Visualizar datos**: Crear y personalizar paneles para mostrar métricas, registros y trazas en tiempo real
|
||||
- **Monitorizar salud y estado**: Comprobar la salud de tu instancia de Grafana y las fuentes de datos conectadas
|
||||
- **Gestionar alertas y anotaciones**: Configurar reglas de alerta, gestionar notificaciones y anotar paneles con eventos importantes
|
||||
- **Organizar contenido**: Organizar paneles y fuentes de datos en carpetas para una mejor gestión de acceso
|
||||
|
||||
En Sim, la integración de Grafana permite a tus agentes interactuar directamente con tu instancia de Grafana a través de API, habilitando acciones como:
|
||||
|
||||
- Comprobar el estado de salud del servidor Grafana, la base de datos y las fuentes de datos
|
||||
- Recuperar, listar y gestionar paneles, reglas de alerta, anotaciones, fuentes de datos y carpetas
|
||||
- Automatizar la monitorización de tu infraestructura integrando datos y alertas de Grafana en tus automatizaciones de flujo de trabajo
|
||||
|
||||
Estas capacidades permiten a los agentes de Sim monitorizar sistemas, responder proactivamente a las alertas y ayudar a garantizar la fiabilidad y visibilidad de tus servicios, todo como parte de tus flujos de trabajo automatizados.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra Grafana en flujos de trabajo. Gestiona paneles, alertas, anotaciones, fuentes de datos, carpetas y monitoriza el estado de salud.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `grafana_get_dashboard`
|
||||
|
||||
Obtener un panel por su UID
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de organización para instancias Grafana multi-organización |
|
||||
| `dashboardUid` | string | Sí | El UID del panel a recuperar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `dashboard` | json | El objeto JSON completo del panel de control |
|
||||
| `meta` | json | Metadatos del panel de control \(versión, permisos, etc.\) |
|
||||
|
||||
### `grafana_list_dashboards`
|
||||
|
||||
Buscar y listar todos los paneles de control
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de la organización para instancias Grafana multi-organización |
|
||||
| `query` | string | No | Consulta de búsqueda para filtrar paneles por título |
|
||||
| `tag` | string | No | Filtrar por etiqueta \(separadas por comas para múltiples etiquetas\) |
|
||||
| `folderIds` | string | No | Filtrar por IDs de carpetas \(separados por comas\) |
|
||||
| `starred` | boolean | No | Devolver solo paneles destacados |
|
||||
| `limit` | number | No | Número máximo de paneles a devolver |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `dashboards` | array | Lista de resultados de búsqueda de paneles |
|
||||
|
||||
### `grafana_create_dashboard`
|
||||
|
||||
Crear un nuevo panel de control
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de la organización para instancias Grafana multi-organización |
|
||||
| `title` | string | Sí | El título del nuevo panel de control |
|
||||
| `folderUid` | string | No | El UID de la carpeta donde crear el panel de control |
|
||||
| `tags` | string | No | Lista de etiquetas separadas por comas |
|
||||
| `timezone` | string | No | Zona horaria del panel \(p. ej., browser, utc\) |
|
||||
| `refresh` | string | No | Intervalo de actualización automática \(p. ej., 5s, 1m, 5m\) |
|
||||
| `panels` | string | No | Array JSON de configuraciones de paneles |
|
||||
| `overwrite` | boolean | No | Sobrescribir panel existente con el mismo título |
|
||||
| `message` | string | No | Mensaje de commit para la versión del panel |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | El ID numérico del panel de control creado |
|
||||
| `uid` | string | El UID del panel de control creado |
|
||||
| `url` | string | La ruta URL al panel de control |
|
||||
| `status` | string | Estado de la operación \(éxito\) |
|
||||
| `version` | number | El número de versión del panel de control |
|
||||
| `slug` | string | Slug amigable para URL del panel de control |
|
||||
|
||||
### `grafana_update_dashboard`
|
||||
|
||||
Actualiza un panel de control existente. Obtiene el panel de control actual y fusiona tus cambios.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de organización para instancias Grafana multi-organización |
|
||||
| `dashboardUid` | string | Sí | El UID del panel de control a actualizar |
|
||||
| `title` | string | No | Nuevo título para el panel de control |
|
||||
| `folderUid` | string | No | Nuevo UID de carpeta para mover el panel de control |
|
||||
| `tags` | string | No | Lista de nuevas etiquetas separadas por comas |
|
||||
| `timezone` | string | No | Zona horaria del panel de control \(p. ej., browser, utc\) |
|
||||
| `refresh` | string | No | Intervalo de actualización automática \(p. ej., 5s, 1m, 5m\) |
|
||||
| `panels` | string | No | Array JSON de configuraciones de paneles |
|
||||
| `overwrite` | boolean | No | Sobrescribir incluso si hay un conflicto de versiones |
|
||||
| `message` | string | No | Mensaje de commit para esta versión |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | El ID numérico del panel actualizado |
|
||||
| `uid` | string | El UID del panel actualizado |
|
||||
| `url` | string | La ruta URL al panel |
|
||||
| `status` | string | Estado de la operación \(éxito\) |
|
||||
| `version` | number | El nuevo número de versión del panel |
|
||||
| `slug` | string | Slug amigable para URL del panel |
|
||||
|
||||
### `grafana_delete_dashboard`
|
||||
|
||||
Eliminar un panel por su UID
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de organización para instancias Grafana multi-organización |
|
||||
| `dashboardUid` | string | Sí | El UID del panel a eliminar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `title` | string | El título del panel eliminado |
|
||||
| `message` | string | Mensaje de confirmación |
|
||||
| `id` | number | El ID del panel eliminado |
|
||||
|
||||
### `grafana_list_alert_rules`
|
||||
|
||||
Listar todas las reglas de alerta en la instancia de Grafana
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de organización para instancias Grafana multi-organización |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `rules` | array | Lista de reglas de alerta |
|
||||
|
||||
### `grafana_get_alert_rule`
|
||||
|
||||
Obtener una regla de alerta específica por su UID
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de organización para instancias Grafana multi-organización |
|
||||
| `alertRuleUid` | string | Sí | El UID de la regla de alerta a recuperar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `uid` | string | UID de la regla de alerta |
|
||||
| `title` | string | Título de la regla de alerta |
|
||||
| `condition` | string | Condición de alerta |
|
||||
| `data` | json | Datos de consulta de la regla de alerta |
|
||||
| `folderUID` | string | UID de la carpeta principal |
|
||||
| `ruleGroup` | string | Nombre del grupo de reglas |
|
||||
| `noDataState` | string | Estado cuando no se devuelven datos |
|
||||
| `execErrState` | string | Estado en caso de error de ejecución |
|
||||
| `annotations` | json | Anotaciones de alerta |
|
||||
| `labels` | json | Etiquetas de alerta |
|
||||
|
||||
### `grafana_create_alert_rule`
|
||||
|
||||
Crear una nueva regla de alerta
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de organización para instancias Grafana multi-organización |
|
||||
| `title` | string | Sí | El título de la regla de alerta |
|
||||
| `folderUid` | string | Sí | El UID de la carpeta donde crear la alerta |
|
||||
| `ruleGroup` | string | Sí | El nombre del grupo de reglas |
|
||||
| `condition` | string | Sí | El refId de la consulta o expresión a usar como condición de alerta |
|
||||
| `data` | string | Sí | Array JSON de objetos de datos de consulta/expresión |
|
||||
| `forDuration` | string | No | Duración de espera antes de activarse \(p. ej., 5m, 1h\) |
|
||||
| `noDataState` | string | No | Estado cuando no se devuelven datos \(NoData, Alerting, OK\) |
|
||||
| `execErrState` | string | No | Estado en caso de error de ejecución \(Alerting, OK\) |
|
||||
| `annotations` | string | No | Objeto JSON de anotaciones |
|
||||
| `labels` | string | No | Objeto JSON de etiquetas |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `uid` | string | El UID de la regla de alerta creada |
|
||||
| `title` | string | Título de la regla de alerta |
|
||||
| `folderUID` | string | UID de la carpeta principal |
|
||||
| `ruleGroup` | string | Nombre del grupo de reglas |
|
||||
|
||||
### `grafana_update_alert_rule`
|
||||
|
||||
Actualiza una regla de alerta existente. Obtiene la regla actual y fusiona tus cambios.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana (p. ej., https://your-grafana.com) |
|
||||
| `organizationId` | string | No | ID de la organización para instancias de Grafana multi-organización |
|
||||
| `alertRuleUid` | string | Sí | El UID de la regla de alerta a actualizar |
|
||||
| `title` | string | No | Nuevo título para la regla de alerta |
|
||||
| `folderUid` | string | No | Nuevo UID de carpeta para mover la alerta |
|
||||
| `ruleGroup` | string | No | Nuevo nombre del grupo de reglas |
|
||||
| `condition` | string | No | Nuevo refId de condición |
|
||||
| `data` | string | No | Nuevo array JSON de objetos de datos de consulta/expresión |
|
||||
| `forDuration` | string | No | Duración de espera antes de activar (p. ej., 5m, 1h) |
|
||||
| `noDataState` | string | No | Estado cuando no se devuelven datos (NoData, Alerting, OK) |
|
||||
| `execErrState` | string | No | Estado en caso de error de ejecución (Alerting, OK) |
|
||||
| `annotations` | string | No | Objeto JSON de anotaciones |
|
||||
| `labels` | string | No | Objeto JSON de etiquetas |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `uid` | string | El UID de la regla de alerta actualizada |
|
||||
| `title` | string | Título de la regla de alerta |
|
||||
| `folderUID` | string | UID de la carpeta principal |
|
||||
| `ruleGroup` | string | Nombre del grupo de reglas |
|
||||
|
||||
### `grafana_delete_alert_rule`
|
||||
|
||||
Eliminar una regla de alerta por su UID
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana (p. ej., https://your-grafana.com) |
|
||||
| `organizationId` | string | No | ID de la organización para instancias de Grafana multi-organización |
|
||||
| `alertRuleUid` | string | Sí | El UID de la regla de alerta a eliminar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de confirmación |
|
||||
|
||||
### `grafana_list_contact_points`
|
||||
|
||||
Listar todos los puntos de contacto para notificaciones de alerta
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana (p. ej., https://your-grafana.com) |
|
||||
| `organizationId` | string | No | ID de la organización para instancias de Grafana multi-organización |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contactPoints` | array | Lista de puntos de contacto |
|
||||
|
||||
### `grafana_create_annotation`
|
||||
|
||||
Crear una anotación en un panel o como una anotación global
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de la organización para instancias de Grafana multi-organización |
|
||||
| `text` | string | Sí | El contenido de texto de la anotación |
|
||||
| `tags` | string | No | Lista de etiquetas separadas por comas |
|
||||
| `dashboardUid` | string | No | UID del panel donde añadir la anotación \(opcional para anotaciones globales\) |
|
||||
| `panelId` | number | No | ID del panel donde añadir la anotación |
|
||||
| `time` | number | No | Hora de inicio en milisegundos de época \(por defecto es ahora\) |
|
||||
| `timeEnd` | number | No | Hora de finalización en milisegundos de época \(para anotaciones de rango\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | El ID de la anotación creada |
|
||||
| `message` | string | Mensaje de confirmación |
|
||||
|
||||
### `grafana_list_annotations`
|
||||
|
||||
Consultar anotaciones por rango de tiempo, panel o etiquetas
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de la organización para instancias de Grafana multi-organización |
|
||||
| `from` | number | No | Hora de inicio en milisegundos de época |
|
||||
| `to` | number | No | Hora de finalización en milisegundos de época |
|
||||
| `dashboardUid` | string | No | Filtrar por UID del panel |
|
||||
| `panelId` | number | No | Filtrar por ID del panel |
|
||||
| `tags` | string | No | Lista de etiquetas separadas por comas para filtrar |
|
||||
| `type` | string | No | Filtrar por tipo \(alerta o anotación\) |
|
||||
| `limit` | number | No | Número máximo de anotaciones a devolver |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `annotations` | array | Lista de anotaciones |
|
||||
|
||||
### `grafana_update_annotation`
|
||||
|
||||
Actualizar una anotación existente
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de organización para instancias Grafana multi-organización |
|
||||
| `annotationId` | number | Sí | El ID de la anotación a actualizar |
|
||||
| `text` | string | Sí | Nuevo contenido de texto para la anotación |
|
||||
| `tags` | string | No | Lista de nuevas etiquetas separadas por comas |
|
||||
| `time` | number | No | Nueva hora de inicio en milisegundos de época |
|
||||
| `timeEnd` | number | No | Nueva hora de finalización en milisegundos de época |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | El ID de la anotación actualizada |
|
||||
| `message` | string | Mensaje de confirmación |
|
||||
|
||||
### `grafana_delete_annotation`
|
||||
|
||||
Eliminar una anotación por su ID
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de organización para instancias Grafana multi-organización |
|
||||
| `annotationId` | number | Sí | El ID de la anotación a eliminar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de confirmación |
|
||||
|
||||
### `grafana_list_data_sources`
|
||||
|
||||
Listar todas las fuentes de datos configuradas en Grafana
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana (ej., https://your-grafana.com) |
|
||||
| `organizationId` | string | No | ID de organización para instancias Grafana multi-organización |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `dataSources` | array | Lista de fuentes de datos |
|
||||
|
||||
### `grafana_get_data_source`
|
||||
|
||||
Obtener una fuente de datos por su ID o UID
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana (ej., https://your-grafana.com) |
|
||||
| `organizationId` | string | No | ID de organización para instancias Grafana multi-organización |
|
||||
| `dataSourceId` | string | Sí | El ID o UID de la fuente de datos a recuperar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | ID de la fuente de datos |
|
||||
| `uid` | string | UID de la fuente de datos |
|
||||
| `name` | string | Nombre de la fuente de datos |
|
||||
| `type` | string | Tipo de fuente de datos |
|
||||
| `url` | string | URL de conexión de la fuente de datos |
|
||||
| `database` | string | Nombre de la base de datos (si aplica) |
|
||||
| `isDefault` | boolean | Si esta es la fuente de datos predeterminada |
|
||||
| `jsonData` | json | Configuración adicional de la fuente de datos |
|
||||
|
||||
### `grafana_list_folders`
|
||||
|
||||
Listar todas las carpetas en Grafana
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de la organización para instancias de Grafana multi-organización |
|
||||
| `limit` | number | No | Número máximo de carpetas a devolver |
|
||||
| `page` | number | No | Número de página para paginación |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `folders` | array | Lista de carpetas |
|
||||
|
||||
### `grafana_create_folder`
|
||||
|
||||
Crear una nueva carpeta en Grafana
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Token de cuenta de servicio de Grafana |
|
||||
| `baseUrl` | string | Sí | URL de la instancia de Grafana \(p. ej., https://your-grafana.com\) |
|
||||
| `organizationId` | string | No | ID de la organización para instancias de Grafana multi-organización |
|
||||
| `title` | string | Sí | El título de la nueva carpeta |
|
||||
| `uid` | string | No | UID opcional para la carpeta \(se genera automáticamente si no se proporciona\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | number | El ID numérico de la carpeta creada |
|
||||
| `uid` | string | El UID de la carpeta creada |
|
||||
| `title` | string | El título de la carpeta creada |
|
||||
| `url` | string | La ruta URL a la carpeta |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `grafana`
|
||||
295
apps/docs/content/docs/es/tools/kalshi.mdx
Normal file
295
apps/docs/content/docs/es/tools/kalshi.mdx
Normal file
@@ -0,0 +1,295 @@
|
||||
---
|
||||
title: Kalshi
|
||||
description: Accede a datos de mercados de predicción de Kalshi
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="kalshi"
|
||||
color="#09C285"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Kalshi](https://kalshi.com) es un mercado regulado federalmente donde los usuarios pueden operar directamente sobre los resultados de eventos futuros—mercados de predicción. La robusta API de Kalshi y la integración con Sim permiten a los agentes y flujos de trabajo acceder programáticamente a todos los aspectos de la plataforma, admitiendo desde investigación y análisis hasta operaciones automatizadas y monitoreo.
|
||||
|
||||
Con la integración de Kalshi en Sim, puedes:
|
||||
|
||||
- **Datos de mercados y eventos:** Buscar, filtrar y obtener datos en tiempo real e históricos de mercados y eventos; obtener detalles granulares sobre el estado del mercado, series, agrupaciones de eventos y más.
|
||||
- **Gestión de cuentas y saldos:** Acceder a saldos de cuenta, fondos disponibles y monitorear posiciones abiertas en tiempo real.
|
||||
- **Gestión de órdenes y operaciones:** Colocar nuevas órdenes, cancelar las existentes, ver órdenes abiertas, obtener un libro de órdenes en vivo y acceder a historiales completos de operaciones.
|
||||
- **Análisis de ejecución:** Obtener operaciones recientes, ejecuciones históricas y datos de velas para backtesting o investigación de estructura de mercado.
|
||||
- **Monitoreo:** Verificar el estado de todo el mercado o a nivel de series, recibir actualizaciones en tiempo real sobre cambios en el mercado o interrupciones de operaciones, y automatizar respuestas.
|
||||
- **Listo para automatización:** Construir agentes automatizados y paneles de control de extremo a extremo que consuman, analicen y operen con probabilidades de eventos del mundo real.
|
||||
|
||||
Al utilizar estas herramientas y puntos de acceso unificados, puedes incorporar sin problemas los mercados de predicción de Kalshi, capacidades de operación en vivo y datos profundos de eventos en tus aplicaciones impulsadas por IA, paneles de control y flujos de trabajo, permitiendo una toma de decisiones sofisticada y automatizada vinculada a resultados del mundo real.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra los mercados de predicción de Kalshi en el flujo de trabajo. Puede obtener mercados, mercado, eventos, evento, saldo, posiciones, órdenes, libro de órdenes, operaciones, velas, ejecuciones, series y estado del mercado.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `kalshi_get_markets`
|
||||
|
||||
Obtener una lista de mercados de predicción de Kalshi con filtrado opcional
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `status` | string | No | Filtrar por estado \(unopened, open, closed, settled\) |
|
||||
| `seriesTicker` | string | No | Filtrar por ticker de serie |
|
||||
| `eventTicker` | string | No | Filtrar por ticker de evento |
|
||||
| `limit` | string | No | Número de resultados \(1-1000, predeterminado: 100\) |
|
||||
| `cursor` | string | No | Cursor de paginación para la siguiente página |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de mercados y metadatos |
|
||||
|
||||
### `kalshi_get_market`
|
||||
|
||||
Obtener detalles de un mercado de predicción específico por ticker
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `ticker` | string | Sí | El ticker del mercado \(p. ej., "KXBTC-24DEC31"\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del mercado y metadatos |
|
||||
|
||||
### `kalshi_get_events`
|
||||
|
||||
Obtener una lista de eventos de Kalshi con filtrado opcional
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `status` | string | No | Filtrar por estado \(open, closed, settled\) |
|
||||
| `seriesTicker` | string | No | Filtrar por ticker de serie |
|
||||
| `withNestedMarkets` | string | No | Incluir mercados anidados en la respuesta \(true/false\) |
|
||||
| `limit` | string | No | Número de resultados \(1-200, predeterminado: 200\) |
|
||||
| `cursor` | string | No | Cursor de paginación para la siguiente página |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos de eventos |
|
||||
|
||||
### `kalshi_get_event`
|
||||
|
||||
Recuperar detalles de un evento específico por ticker
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `eventTicker` | string | Sí | El ticker del evento |
|
||||
| `withNestedMarkets` | string | No | Incluir mercados anidados en la respuesta \(true/false\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos del evento |
|
||||
|
||||
### `kalshi_get_balance`
|
||||
|
||||
Recuperar el saldo de tu cuenta y el valor de la cartera desde Kalshi
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Sí | Tu ID de clave API de Kalshi |
|
||||
| `privateKey` | string | Sí | Tu clave privada RSA \(formato PEM\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos del saldo |
|
||||
|
||||
### `kalshi_get_positions`
|
||||
|
||||
Recuperar tus posiciones abiertas desde Kalshi
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Sí | Tu ID de clave API de Kalshi |
|
||||
| `privateKey` | string | Sí | Tu clave privada RSA \(formato PEM\) |
|
||||
| `ticker` | string | No | Filtrar por ticker de mercado |
|
||||
| `eventTicker` | string | No | Filtrar por ticker de evento \(máximo 10 separados por comas\) |
|
||||
| `settlementStatus` | string | No | Filtrar por estado de liquidación \(all, unsettled, settled\). Predeterminado: unsettled |
|
||||
| `limit` | string | No | Número de resultados \(1-1000, predeterminado: 100\) |
|
||||
| `cursor` | string | No | Cursor de paginación para la siguiente página |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de posiciones y metadatos |
|
||||
|
||||
### `kalshi_get_orders`
|
||||
|
||||
Recupera tus órdenes de Kalshi con filtrado opcional
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Sí | Tu ID de clave API de Kalshi |
|
||||
| `privateKey` | string | Sí | Tu clave privada RSA \(formato PEM\) |
|
||||
| `ticker` | string | No | Filtrar por ticker de mercado |
|
||||
| `eventTicker` | string | No | Filtrar por ticker de evento \(máximo 10 separados por comas\) |
|
||||
| `status` | string | No | Filtrar por estado \(en espera, cancelado, ejecutado\) |
|
||||
| `limit` | string | No | Número de resultados \(1-200, predeterminado: 100\) |
|
||||
| `cursor` | string | No | Cursor de paginación para la siguiente página |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de órdenes y metadatos |
|
||||
|
||||
### `kalshi_get_orderbook`
|
||||
|
||||
Recupera el libro de órdenes (ofertas de compra y venta) para un mercado específico
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `ticker` | string | Sí | Ticker del mercado \(p. ej., KXBTC-24DEC31\) |
|
||||
| `depth` | number | No | Número de niveles de precio a devolver por lado |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos del libro de órdenes |
|
||||
|
||||
### `kalshi_get_trades`
|
||||
|
||||
Recuperar operaciones recientes en todos los mercados o para un mercado específico
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `ticker` | string | No | Filtrar por ticker de mercado |
|
||||
| `minTs` | number | No | Marca de tiempo mínima \(Unix en milisegundos\) |
|
||||
| `maxTs` | number | No | Marca de tiempo máxima \(Unix en milisegundos\) |
|
||||
| `limit` | string | No | Número de resultados \(1-1000, predeterminado: 100\) |
|
||||
| `cursor` | string | No | Cursor de paginación para la siguiente página |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos de operaciones |
|
||||
|
||||
### `kalshi_get_candlesticks`
|
||||
|
||||
Recuperar datos de velas OHLC para un mercado específico
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `seriesTicker` | string | Sí | Ticker de serie |
|
||||
| `ticker` | string | Sí | Ticker de mercado \(p. ej., KXBTC-24DEC31\) |
|
||||
| `startTs` | number | No | Marca de tiempo de inicio \(Unix en milisegundos\) |
|
||||
| `endTs` | number | No | Marca de tiempo de fin \(Unix en milisegundos\) |
|
||||
| `periodInterval` | number | No | Intervalo de período: 1 \(1min\), 60 \(1hora\), o 1440 \(1día\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de velas e información adicional |
|
||||
|
||||
### `kalshi_get_fills`
|
||||
|
||||
Recuperar tu cartera
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `keyId` | string | Sí | Tu ID de clave API de Kalshi |
|
||||
| `privateKey` | string | Sí | Tu clave privada RSA (formato PEM) |
|
||||
| `ticker` | string | No | Filtrar por ticker de mercado |
|
||||
| `orderId` | string | No | Filtrar por ID de orden |
|
||||
| `minTs` | number | No | Marca de tiempo mínima (milisegundos Unix) |
|
||||
| `maxTs` | number | No | Marca de tiempo máxima (milisegundos Unix) |
|
||||
| `limit` | string | No | Número de resultados (1-1000, predeterminado: 100) |
|
||||
| `cursor` | string | No | Cursor de paginación para la siguiente página |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de ejecuciones e información adicional |
|
||||
|
||||
### `kalshi_get_series_by_ticker`
|
||||
|
||||
Recuperar detalles de una serie de mercado específica por ticker
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `seriesTicker` | string | Sí | Ticker de la serie |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de la serie e información adicional |
|
||||
|
||||
### `kalshi_get_exchange_status`
|
||||
|
||||
Recupera el estado actual del intercambio Kalshi (actividad de trading y del intercambio)
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de estado del intercambio y metadatos |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `kalshi`
|
||||
83
apps/docs/content/docs/es/tools/linkedin.mdx
Normal file
83
apps/docs/content/docs/es/tools/linkedin.mdx
Normal file
@@ -0,0 +1,83 @@
|
||||
---
|
||||
title: LinkedIn
|
||||
description: Comparte publicaciones y gestiona tu presencia en LinkedIn
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="linkedin"
|
||||
color="#0072B1"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[LinkedIn](https://www.linkedin.com) es la plataforma de redes profesionales más grande del mundo, que permite a los usuarios desarrollar sus carreras, conectarse con su red y compartir contenido profesional. LinkedIn es ampliamente utilizado por profesionales de diversas industrias para branding personal, reclutamiento, búsqueda de empleo y desarrollo de negocios.
|
||||
|
||||
Con LinkedIn, puedes compartir fácilmente publicaciones en tu feed personal para interactuar con tu red y acceder a información sobre tu perfil para destacar tus logros profesionales. La integración automatizada con Sim te permite aprovechar la funcionalidad de LinkedIn de forma programática, permitiendo que agentes y flujos de trabajo publiquen actualizaciones, informen sobre tu presencia profesional y mantengan tu feed activo sin esfuerzo manual.
|
||||
|
||||
Las características clave de LinkedIn disponibles a través de esta integración incluyen:
|
||||
|
||||
- **Compartir publicaciones:** Publica automáticamente actualizaciones profesionales, artículos o anuncios en tu feed personal de LinkedIn.
|
||||
- **Información del perfil:** Obtén información detallada sobre tu perfil de LinkedIn para monitorear o usar en tareas posteriores dentro de tus flujos de trabajo.
|
||||
|
||||
Estas capacidades facilitan mantener tu red de LinkedIn comprometida y extender tu alcance profesional de manera eficiente como parte de tu estrategia de automatización de IA o flujo de trabajo.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra LinkedIn en flujos de trabajo. Comparte publicaciones en tu feed personal y accede a la información de tu perfil de LinkedIn.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `linkedin_share_post`
|
||||
|
||||
Comparte una publicación en tu feed personal de LinkedIn
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `text` | string | Sí | El contenido de texto de tu publicación en LinkedIn |
|
||||
| `visibility` | string | No | Quién puede ver esta publicación: "PUBLIC" o "CONNECTIONS" \(predeterminado: "PUBLIC"\) |
|
||||
| `request` | string | No | Sin descripción |
|
||||
| `output` | string | No | Sin descripción |
|
||||
| `output` | string | No | Sin descripción |
|
||||
| `specificContent` | string | No | Sin descripción |
|
||||
| `shareCommentary` | string | No | Sin descripción |
|
||||
| `visibility` | string | No | Sin descripción |
|
||||
| `headers` | string | No | Sin descripción |
|
||||
| `output` | string | No | Sin descripción |
|
||||
| `output` | string | No | Sin descripción |
|
||||
| `output` | string | No | Sin descripción |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `postId` | string | ID de la publicación creada |
|
||||
| `profile` | json | Información del perfil de LinkedIn |
|
||||
| `error` | string | Mensaje de error si la operación falló |
|
||||
|
||||
### `linkedin_get_profile`
|
||||
|
||||
Recuperar la información de tu perfil de LinkedIn
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `postId` | string | ID de la publicación creada |
|
||||
| `profile` | json | Información del perfil de LinkedIn |
|
||||
| `error` | string | Mensaje de error si la operación falló |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `linkedin`
|
||||
216
apps/docs/content/docs/es/tools/mailgun.mdx
Normal file
216
apps/docs/content/docs/es/tools/mailgun.mdx
Normal file
@@ -0,0 +1,216 @@
|
||||
---
|
||||
title: Mailgun
|
||||
description: Envía correos electrónicos y gestiona listas de correo con Mailgun
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="mailgun"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Mailgun](https://www.mailgun.com) es un potente servicio de envío de correos electrónicos diseñado para desarrolladores y empresas que permite enviar, recibir y rastrear correos electrónicos sin esfuerzo. Mailgun te permite aprovechar APIs robustas para correos electrónicos transaccionales y de marketing confiables, gestión flexible de listas de correo y seguimiento avanzado de eventos.
|
||||
|
||||
Con el conjunto completo de funciones de Mailgun, puedes automatizar operaciones clave de correo electrónico y monitorear de cerca la entregabilidad y el compromiso de los destinatarios. Esto lo convierte en una solución ideal para la automatización de flujos de trabajo donde las comunicaciones, notificaciones y correos de campaña son partes fundamentales de tus procesos.
|
||||
|
||||
Las características principales de Mailgun incluyen:
|
||||
|
||||
- **Envío de correos electrónicos transaccionales:** Entrega correos electrónicos de alto volumen como notificaciones de cuenta, recibos, alertas y restablecimientos de contraseña.
|
||||
- **Contenido de correo electrónico enriquecido:** Envía correos electrónicos tanto en texto plano como en HTML, y utiliza etiquetas para categorizar y rastrear tus mensajes.
|
||||
- **Gestión de listas de correo:** Crea, actualiza y gestiona listas de correo y miembros para enviar comunicaciones grupales de manera eficiente.
|
||||
- **Información de dominio:** Obtén detalles sobre tus dominios de envío para monitorear la configuración y el estado.
|
||||
- **Seguimiento de eventos:** Analiza la entregabilidad y el compromiso del correo electrónico con datos detallados de eventos en los mensajes enviados.
|
||||
- **Recuperación de mensajes:** Accede a mensajes almacenados para necesidades de cumplimiento, análisis o solución de problemas.
|
||||
|
||||
Al integrar Mailgun en Sim, tus agentes pueden enviar correos electrónicos programáticamente, gestionar listas de correo, acceder a información de dominio y monitorear eventos en tiempo real como parte de flujos de trabajo automatizados. Esto permite una participación inteligente y basada en datos con tus usuarios directamente desde tus procesos impulsados por IA.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra Mailgun en tu flujo de trabajo. Envía correos electrónicos transaccionales, gestiona listas de correo y miembros, visualiza información de dominio y realiza seguimiento de eventos de correo electrónico. Compatible con correos electrónicos de texto y HTML, etiquetas para seguimiento y gestión integral de listas.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `mailgun_send_message`
|
||||
|
||||
Enviar un correo electrónico usando la API de Mailgun
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de Mailgun |
|
||||
| `domain` | string | Sí | Dominio de Mailgun \(ej., mg.example.com\) |
|
||||
| `from` | string | Sí | Dirección de correo del remitente |
|
||||
| `to` | string | Sí | Dirección de correo del destinatario \(separados por comas para múltiples\) |
|
||||
| `subject` | string | Sí | Asunto del correo electrónico |
|
||||
| `text` | string | No | Cuerpo de texto plano del correo electrónico |
|
||||
| `html` | string | No | Cuerpo HTML del correo electrónico |
|
||||
| `cc` | string | No | Dirección de correo CC \(separados por comas para múltiples\) |
|
||||
| `bcc` | string | No | Dirección de correo BCC \(separados por comas para múltiples\) |
|
||||
| `tags` | string | No | Etiquetas para el correo electrónico \(separadas por comas\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si el mensaje fue enviado con éxito |
|
||||
| `id` | string | ID del mensaje |
|
||||
| `message` | string | Mensaje de respuesta de Mailgun |
|
||||
|
||||
### `mailgun_get_message`
|
||||
|
||||
Recuperar un mensaje almacenado por su clave
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de Mailgun |
|
||||
| `domain` | string | Sí | Dominio de Mailgun |
|
||||
| `messageKey` | string | Sí | Clave de almacenamiento del mensaje |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la solicitud fue exitosa |
|
||||
| `recipients` | string | Destinatarios del mensaje |
|
||||
| `from` | string | Correo electrónico del remitente |
|
||||
| `subject` | string | Asunto del mensaje |
|
||||
| `bodyPlain` | string | Cuerpo en texto plano |
|
||||
| `strippedText` | string | Texto simplificado |
|
||||
| `strippedSignature` | string | Firma simplificada |
|
||||
| `bodyHtml` | string | Cuerpo HTML |
|
||||
| `strippedHtml` | string | HTML simplificado |
|
||||
| `attachmentCount` | number | Número de archivos adjuntos |
|
||||
| `timestamp` | number | Marca de tiempo del mensaje |
|
||||
| `messageHeaders` | json | Encabezados del mensaje |
|
||||
| `contentIdMap` | json | Mapa de ID de contenido |
|
||||
|
||||
### `mailgun_list_messages`
|
||||
|
||||
Listar eventos (registros) para mensajes enviados a través de Mailgun
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de Mailgun |
|
||||
| `domain` | string | Sí | Dominio de Mailgun |
|
||||
| `event` | string | No | Filtrar por tipo de evento \(accepted, delivered, failed, opened, clicked, etc.\) |
|
||||
| `limit` | number | No | Número máximo de eventos a devolver \(predeterminado: 100\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la solicitud fue exitosa |
|
||||
| `items` | json | Array de elementos de eventos |
|
||||
| `paging` | json | Información de paginación |
|
||||
|
||||
### `mailgun_create_mailing_list`
|
||||
|
||||
Crear una nueva lista de correo
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de Mailgun |
|
||||
| `address` | string | Sí | Dirección de la lista de correo \(ej., lista@ejemplo.com\) |
|
||||
| `name` | string | No | Nombre de la lista de correo |
|
||||
| `description` | string | No | Descripción de la lista de correo |
|
||||
| `accessLevel` | string | No | Nivel de acceso: readonly, members, o everyone |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la lista fue creada con éxito |
|
||||
| `message` | string | Mensaje de respuesta |
|
||||
| `list` | json | Detalles de la lista de correo creada |
|
||||
|
||||
### `mailgun_get_mailing_list`
|
||||
|
||||
Obtener detalles de una lista de correo
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de Mailgun |
|
||||
| `address` | string | Sí | Dirección de la lista de correo |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la solicitud fue exitosa |
|
||||
| `list` | json | Detalles de la lista de correo |
|
||||
|
||||
### `mailgun_add_list_member`
|
||||
|
||||
Añadir un miembro a una lista de correo
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de Mailgun |
|
||||
| `listAddress` | string | Sí | Dirección de la lista de correo |
|
||||
| `address` | string | Sí | Dirección de correo electrónico del miembro |
|
||||
| `name` | string | No | Nombre del miembro |
|
||||
| `vars` | string | No | Cadena JSON de variables personalizadas |
|
||||
| `subscribed` | boolean | No | Si el miembro está suscrito |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si el miembro fue añadido con éxito |
|
||||
| `message` | string | Mensaje de respuesta |
|
||||
| `member` | json | Detalles del miembro añadido |
|
||||
|
||||
### `mailgun_list_domains`
|
||||
|
||||
Listar todos los dominios para tu cuenta de Mailgun
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de Mailgun |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la solicitud fue exitosa |
|
||||
| `totalCount` | number | Número total de dominios |
|
||||
| `items` | json | Array de objetos de dominio |
|
||||
|
||||
### `mailgun_get_domain`
|
||||
|
||||
Obtener detalles de un dominio específico
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de Mailgun |
|
||||
| `domain` | string | Sí | Nombre de dominio |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la solicitud fue exitosa |
|
||||
| `domain` | json | Detalles del dominio |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `mailgun`
|
||||
352
apps/docs/content/docs/es/tools/polymarket.mdx
Normal file
352
apps/docs/content/docs/es/tools/polymarket.mdx
Normal file
@@ -0,0 +1,352 @@
|
||||
---
|
||||
title: Polymarket
|
||||
description: Accede a datos de mercados de predicción desde Polymarket
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="polymarket"
|
||||
color="#4C82FB"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Polymarket](https://polymarket.com) es una plataforma descentralizada de mercados de predicción donde los usuarios pueden operar sobre el resultado de eventos futuros utilizando tecnología blockchain. Polymarket proporciona una API completa, permitiendo a desarrolladores y agentes acceder a datos de mercado en vivo, listados de eventos, información de precios y estadísticas de libro de órdenes para potenciar flujos de trabajo basados en datos y automatizaciones de IA.
|
||||
|
||||
Con la API de Polymarket y la integración de Sim, puedes permitir que los agentes recuperen programáticamente información de mercados de predicción, exploren mercados abiertos y eventos asociados, analicen datos históricos de precios y accedan a libros de órdenes y puntos medios del mercado. Esto crea nuevas posibilidades para la investigación, análisis automatizado y desarrollo de agentes inteligentes que reaccionan a probabilidades de eventos en tiempo real derivadas de los precios del mercado.
|
||||
|
||||
Las características principales de la integración de Polymarket incluyen:
|
||||
|
||||
- **Listado y filtrado de mercados:** Lista todos los mercados de predicción actuales o históricos, filtra por etiqueta, ordena y navega por los resultados paginados.
|
||||
- **Detalle del mercado:** Recupera detalles de un solo mercado por ID o slug, incluyendo sus resultados y estado.
|
||||
- **Listados de eventos:** Accede a listas de eventos de Polymarket e información detallada de eventos.
|
||||
- **Libro de órdenes y datos de precios:** Analiza el libro de órdenes, obtén los últimos precios del mercado, visualiza el punto medio u obtén información histórica de precios para cualquier mercado.
|
||||
- **Listo para automatización:** Construye agentes o herramientas que reaccionan programáticamente a desarrollos del mercado, cambios en las probabilidades o resultados específicos de eventos.
|
||||
|
||||
Al utilizar estos endpoints de API documentados, puedes integrar perfectamente los ricos datos de mercados de predicción en cadena de Polymarket en tus propios flujos de trabajo de IA, paneles de control, herramientas de investigación y automatizaciones de trading.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra los mercados de predicción de Polymarket en el flujo de trabajo. Puede obtener mercados, mercado, eventos, evento, etiquetas, series, libro de órdenes, precio, punto medio, historial de precios, último precio de operación, diferencial, tamaño de tick, posiciones, operaciones y búsqueda.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `polymarket_get_markets`
|
||||
|
||||
Obtener una lista de mercados de predicción de Polymarket con filtrado opcional
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `closed` | string | No | Filtrar por estado cerrado \(true/false\). Usa false para mercados activos solamente. |
|
||||
| `order` | string | No | Campo de ordenación \(p. ej., id, volume, liquidity\) |
|
||||
| `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 \(recomendado: 25-50\) |
|
||||
| `offset` | string | No | Desplazamiento de paginación \(omitir esta cantidad de resultados\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de mercados y metadatos |
|
||||
|
||||
### `polymarket_get_market`
|
||||
|
||||
Obtener detalles de un mercado de predicción específico por ID o slug
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `marketId` | string | No | El ID del mercado. Requerido si no se proporciona el slug. |
|
||||
| `slug` | string | No | El slug del mercado \(p. ej., "will-trump-win"\). Requerido si no se proporciona marketId. |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de mercado y metadatos |
|
||||
|
||||
### `polymarket_get_events`
|
||||
|
||||
Obtener una lista de eventos de Polymarket con filtrado opcional
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `closed` | string | No | Filtrar por estado cerrado (true/false). Usar false para eventos activos solamente. |
|
||||
| `order` | string | No | Campo de ordenación (ej., id, volume) |
|
||||
| `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 (recomendado: 25-50) |
|
||||
| `offset` | string | No | Desplazamiento de paginación (omitir esta cantidad de resultados) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de eventos y metadatos |
|
||||
|
||||
### `polymarket_get_event`
|
||||
|
||||
Obtener detalles de un evento específico por ID o slug
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `eventId` | string | No | El ID del evento. Requerido si no se proporciona el slug. |
|
||||
| `slug` | string | No | El slug del evento (ej., "2024-presidential-election"). Requerido si no se proporciona eventId. |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos del evento |
|
||||
|
||||
### `polymarket_get_tags`
|
||||
|
||||
Obtener etiquetas disponibles para filtrar mercados de Polymarket
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripció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 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos de etiquetas |
|
||||
|
||||
### `polymarket_search`
|
||||
|
||||
Buscar mercados, eventos y perfiles en Polymarket
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Sí | Término de búsqueda |
|
||||
| `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 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Resultados de búsqueda y metadatos |
|
||||
|
||||
### `polymarket_get_series`
|
||||
|
||||
Obtener series (grupos de mercados relacionados) de Polymarket
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripció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 |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos de la serie |
|
||||
|
||||
### `polymarket_get_series_by_id`
|
||||
|
||||
Recuperar una serie específica (grupo de mercado relacionado) por ID desde Polymarket
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `seriesId` | string | Sí | El ID de la serie |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos de la serie |
|
||||
|
||||
### `polymarket_get_orderbook`
|
||||
|
||||
Recuperar el resumen del libro de órdenes para un token específico
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Sí | El ID del token CLOB (de los clobTokenIds del mercado) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos y metadatos del libro de órdenes |
|
||||
|
||||
### `polymarket_get_price`
|
||||
|
||||
Recuperar el precio de mercado para un token y lado específicos
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Sí | El ID del token CLOB (de los clobTokenIds del mercado) |
|
||||
| `side` | string | Sí | Lado de la orden: compra o venta |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de precio y metadatos |
|
||||
|
||||
### `polymarket_get_midpoint`
|
||||
|
||||
Recuperar el precio medio para un token específico
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Sí | El ID del token CLOB (de los clobTokenIds del mercado) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del precio medio y metadatos |
|
||||
|
||||
### `polymarket_get_price_history`
|
||||
|
||||
Recuperar datos históricos de precios para un token de mercado específico
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Sí | El ID del token CLOB (de los clobTokenIds del mercado) |
|
||||
| `interval` | string | No | Duración que termina en el tiempo actual (1m, 1h, 6h, 1d, 1w, max). Mutuamente excluyente con startTs/endTs. |
|
||||
| `fidelity` | number | No | Resolución de datos en minutos (por ejemplo, 60 para datos por hora) |
|
||||
| `startTs` | number | No | Marca de tiempo de inicio (segundos Unix UTC) |
|
||||
| `endTs` | number | No | Marca de tiempo de fin (segundos Unix UTC) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del historial de precios y metadatos |
|
||||
|
||||
### `polymarket_get_last_trade_price`
|
||||
|
||||
Recuperar el último precio de operación para un token específico
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Sí | El ID del token CLOB (de los clobTokenIds del mercado) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Último precio de operación y metadatos |
|
||||
|
||||
### `polymarket_get_spread`
|
||||
|
||||
Recuperar el diferencial de oferta y demanda para un token específico
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Sí | El ID del token CLOB (de los clobTokenIds del mercado) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos del diferencial y metadatos |
|
||||
|
||||
### `polymarket_get_tick_size`
|
||||
|
||||
Recuperar el tamaño mínimo de tick para un token específico
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `tokenId` | string | Sí | El ID del token CLOB (de los clobTokenIds del mercado) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Tamaño del tick y metadatos |
|
||||
|
||||
### `polymarket_get_positions`
|
||||
|
||||
Recuperar las posiciones del usuario desde Polymarket
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `user` | string | Sí | Dirección de la cartera del usuario |
|
||||
| `market` | string | No | ID de mercado opcional para filtrar posiciones |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de posiciones y metadatos |
|
||||
|
||||
### `polymarket_get_trades`
|
||||
|
||||
Recuperar historial de operaciones de Polymarket
|
||||
|
||||
#### Entrada
|
||||
|
||||
| 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 \(recomendado: 25-50\) |
|
||||
| `offset` | string | No | Desplazamiento de paginación \(omitir esta cantidad de resultados\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `output` | object | Datos de operaciones y metadatos |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `polymarket`
|
||||
@@ -81,12 +81,19 @@ Crear un nuevo problema con propiedades específicas
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiToken` | string | Sí | Token de API de Pylon |
|
||||
| `title` | string | Sí | Título del problema |
|
||||
| `bodyHtml` | string | Sí | Cuerpo del problema en formato HTML |
|
||||
| `accountId` | string | No | ID de cuenta para asociar con el problema |
|
||||
| `assigneeId` | string | No | ID de usuario para asignar el problema |
|
||||
| `accountId` | string | No | ID de la cuenta a asociar con el problema |
|
||||
| `assigneeId` | string | No | ID del usuario al que asignar el problema |
|
||||
| `teamId` | string | No | ID del equipo al que asignar el problema |
|
||||
| `requesterId` | string | No | ID del usuario solicitante \(alternativa a requester_email\) |
|
||||
| `requesterEmail` | string | No | Dirección de correo electrónico del solicitante \(alternativa a requester_id\) |
|
||||
| `priority` | string | No | Prioridad del problema |
|
||||
| `tags` | string | No | IDs de etiquetas separados por comas |
|
||||
| `customFields` | string | No | Campos personalizados como objeto JSON |
|
||||
| `attachmentUrls` | string | No | URLs de archivos adjuntos separados por comas |
|
||||
|
||||
#### Salida
|
||||
|
||||
@@ -124,10 +131,13 @@ Actualizar un problema existente
|
||||
| `apiToken` | string | Sí | Token de API de Pylon |
|
||||
| `issueId` | string | Sí | El ID del problema a actualizar |
|
||||
| `state` | string | No | Estado del problema |
|
||||
| `assigneeId` | string | No | ID de usuario para asignar el problema |
|
||||
| `teamId` | string | No | ID del equipo para asignar el problema |
|
||||
| `assigneeId` | string | No | ID del usuario al que asignar el problema |
|
||||
| `teamId` | string | No | ID del equipo al que asignar el problema |
|
||||
| `tags` | string | No | IDs de etiquetas separados por comas |
|
||||
| `customFields` | string | No | Campos personalizados como objeto JSON |
|
||||
| `customerPortalVisible` | boolean | No | Si el problema es visible en el portal del cliente |
|
||||
| `requesterId` | string | No | ID del usuario solicitante |
|
||||
| `accountId` | string | No | ID de la cuenta a asociar con el problema |
|
||||
|
||||
#### Salida
|
||||
|
||||
|
||||
168
apps/docs/content/docs/es/tools/rds.mdx
Normal file
168
apps/docs/content/docs/es/tools/rds.mdx
Normal file
@@ -0,0 +1,168 @@
|
||||
---
|
||||
title: Amazon RDS
|
||||
description: Conéctate a Amazon RDS a través de Data API
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="rds"
|
||||
color="linear-gradient(45deg, #2E27AD 0%, #527FFF 100%)"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Amazon RDS Aurora Serverless](https://aws.amazon.com/rds/aurora/serverless/) es una base de datos relacional completamente administrada que se inicia, se apaga y escala automáticamente según las necesidades de tu aplicación. Te permite ejecutar bases de datos SQL en la nube sin tener que administrar servidores de bases de datos.
|
||||
|
||||
Con RDS Aurora Serverless, puedes:
|
||||
|
||||
- **Consultar datos**: Ejecutar consultas SQL flexibles en tus tablas
|
||||
- **Insertar nuevos registros**: Añadir datos a tu base de datos automáticamente
|
||||
- **Actualizar registros existentes**: Modificar datos en tus tablas usando filtros personalizados
|
||||
- **Eliminar registros**: Quitar datos no deseados utilizando criterios precisos
|
||||
- **Ejecutar SQL puro**: Ejecutar cualquier comando SQL válido compatible con Aurora
|
||||
|
||||
En Sim, la integración con RDS permite a tus agentes trabajar con bases de datos Amazon Aurora Serverless de forma segura y programática. Las operaciones compatibles incluyen:
|
||||
|
||||
- **Consulta**: Ejecutar SELECT y otras consultas SQL para obtener filas de tu base de datos
|
||||
- **Inserción**: Insertar nuevos registros en tablas con datos estructurados
|
||||
- **Actualización**: Cambiar datos en filas que coincidan con tus condiciones especificadas
|
||||
- **Eliminación**: Eliminar registros de una tabla mediante filtros o criterios personalizados
|
||||
- **Ejecución**: Ejecutar SQL puro para escenarios avanzados
|
||||
|
||||
Esta integración permite a tus agentes automatizar una amplia gama de operaciones de bases de datos sin intervención manual. Al conectar Sim con Amazon RDS, puedes crear agentes que gestionen, actualicen y recuperen datos relacionales dentro de tus flujos de trabajo, todo sin tener que manejar infraestructura o conexiones de bases de datos.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra Amazon RDS Aurora Serverless en el flujo de trabajo utilizando la Data API. Puede consultar, insertar, actualizar, eliminar y ejecutar SQL puro sin administrar conexiones de base de datos.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `rds_query`
|
||||
|
||||
Ejecutar una consulta SELECT en Amazon RDS utilizando la API de datos
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Sí | Región de AWS (p. ej., us-east-1) |
|
||||
| `accessKeyId` | string | Sí | ID de clave de acceso de AWS |
|
||||
| `secretAccessKey` | string | Sí | Clave de acceso secreta de AWS |
|
||||
| `resourceArn` | string | Sí | ARN del clúster de Aurora DB |
|
||||
| `secretArn` | string | Sí | ARN del secreto de Secrets Manager que contiene las credenciales de la base de datos |
|
||||
| `database` | string | No | Nombre de la base de datos (opcional) |
|
||||
| `query` | string | Sí | Consulta SQL SELECT para ejecutar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
| `rows` | array | Array de filas devueltas por la consulta |
|
||||
| `rowCount` | number | Número de filas devueltas |
|
||||
|
||||
### `rds_insert`
|
||||
|
||||
Insertar datos en una tabla de Amazon RDS utilizando la API de datos
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Sí | Región de AWS (p. ej., us-east-1) |
|
||||
| `accessKeyId` | string | Sí | ID de clave de acceso de AWS |
|
||||
| `secretAccessKey` | string | Sí | Clave de acceso secreta de AWS |
|
||||
| `resourceArn` | string | Sí | ARN del clúster de Aurora DB |
|
||||
| `secretArn` | string | Sí | ARN del secreto de Secrets Manager que contiene las credenciales de la base de datos |
|
||||
| `database` | string | No | Nombre de la base de datos (opcional) |
|
||||
| `table` | string | Sí | Nombre de la tabla donde insertar |
|
||||
| `data` | object | Sí | Datos a insertar como pares clave-valor |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
| `rows` | array | Array de filas insertadas |
|
||||
| `rowCount` | number | Número de filas insertadas |
|
||||
|
||||
### `rds_update`
|
||||
|
||||
Actualizar datos en una tabla de Amazon RDS utilizando la API de datos
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Sí | Región de AWS (p. ej., us-east-1) |
|
||||
| `accessKeyId` | string | Sí | ID de clave de acceso de AWS |
|
||||
| `secretAccessKey` | string | Sí | Clave de acceso secreta de AWS |
|
||||
| `resourceArn` | string | Sí | ARN del clúster de Aurora DB |
|
||||
| `secretArn` | string | Sí | ARN del secreto de Secrets Manager que contiene las credenciales de la base de datos |
|
||||
| `database` | string | No | Nombre de la base de datos (opcional) |
|
||||
| `table` | string | Sí | Nombre de la tabla a actualizar |
|
||||
| `data` | object | Sí | Datos a actualizar como pares clave-valor |
|
||||
| `conditions` | object | Sí | Condiciones para la actualización (p. ej., `{"id": 1}`) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
| `rows` | array | Array de filas actualizadas |
|
||||
| `rowCount` | number | Número de filas actualizadas |
|
||||
|
||||
### `rds_delete`
|
||||
|
||||
Eliminar datos de una tabla de Amazon RDS utilizando la API de datos
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Sí | Región de AWS (p. ej., us-east-1) |
|
||||
| `accessKeyId` | string | Sí | ID de clave de acceso de AWS |
|
||||
| `secretAccessKey` | string | Sí | Clave de acceso secreta de AWS |
|
||||
| `resourceArn` | string | Sí | ARN del clúster de Aurora DB |
|
||||
| `secretArn` | string | Sí | ARN del secreto de Secrets Manager que contiene las credenciales de la base de datos |
|
||||
| `database` | string | No | Nombre de la base de datos (opcional) |
|
||||
| `table` | string | Sí | Nombre de la tabla de la que eliminar |
|
||||
| `conditions` | object | Sí | Condiciones para la eliminación (p. ej., `{"id": 1}`) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
| `rows` | array | Array de filas eliminadas |
|
||||
| `rowCount` | number | Número de filas eliminadas |
|
||||
|
||||
### `rds_execute`
|
||||
|
||||
Ejecutar SQL sin procesar en Amazon RDS usando la API de datos
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `region` | string | Sí | Región de AWS (p. ej., us-east-1) |
|
||||
| `accessKeyId` | string | Sí | ID de clave de acceso de AWS |
|
||||
| `secretAccessKey` | string | Sí | Clave de acceso secreta de AWS |
|
||||
| `resourceArn` | string | Sí | ARN del clúster de Aurora DB |
|
||||
| `secretArn` | string | Sí | ARN del secreto de Secrets Manager que contiene las credenciales de la base de datos |
|
||||
| `database` | string | No | Nombre de la base de datos (opcional) |
|
||||
| `query` | string | Sí | Consulta SQL sin procesar para ejecutar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
| `rows` | array | Array de filas devueltas o afectadas |
|
||||
| `rowCount` | number | Número de filas afectadas |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `rds`
|
||||
@@ -7,7 +7,7 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="s3"
|
||||
color="#E0E0E0"
|
||||
color="linear-gradient(45deg, #1B660F 0%, #6CAE3E 100%)"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
|
||||
54
apps/docs/content/docs/es/tools/search.mdx
Normal file
54
apps/docs/content/docs/es/tools/search.mdx
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: Búsqueda
|
||||
description: Busca en la web ($0.01 por búsqueda)
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="search"
|
||||
color="#3B82F6"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
La herramienta de **Búsqueda** te permite buscar en la web desde tus flujos de trabajo de Sim utilizando motores de búsqueda de última generación. Úsala para obtener la información más reciente, noticias, hechos y contenido web directamente en tus agentes, automatizaciones o conversaciones.
|
||||
|
||||
- **Búsqueda general en la web**: Encuentra información actualizada de internet para complementar tus flujos de trabajo.
|
||||
- **Consultas automatizadas**: Permite que los agentes o la lógica del programa envíen consultas de búsqueda y manejen los resultados automáticamente.
|
||||
- **Resultados estructurados**: Devuelve los resultados web más relevantes, incluyendo título, enlace, fragmento y fecha para cada resultado.
|
||||
|
||||
> **Nota:** Cada búsqueda cuesta **$0.01** por consulta.
|
||||
|
||||
Esta herramienta es ideal para cualquier flujo de trabajo donde tus agentes necesiten acceso a datos web en tiempo real o deban hacer referencia a eventos actuales, realizar investigaciones o obtener contenido complementario.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Busca en la web usando la herramienta de Búsqueda. Cada búsqueda cuesta $0.01 por consulta.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `search_tool`
|
||||
|
||||
Busca en la web. Devuelve los resultados web más relevantes, incluyendo título, enlace, fragmento y fecha para cada resultado.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `query` | string | Sí | La consulta de búsqueda |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | json | Resultados de búsqueda |
|
||||
| `query` | string | La consulta de búsqueda |
|
||||
| `totalResults` | number | Número total de resultados |
|
||||
| `source` | string | Fuente de búsqueda \(exa\) |
|
||||
| `cost` | json | Información de costo \($0.01\) |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `search`
|
||||
392
apps/docs/content/docs/es/tools/sendgrid.mdx
Normal file
392
apps/docs/content/docs/es/tools/sendgrid.mdx
Normal file
@@ -0,0 +1,392 @@
|
||||
---
|
||||
title: SendGrid
|
||||
description: Envía correos electrónicos y gestiona contactos, listas y
|
||||
plantillas con SendGrid
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="sendgrid"
|
||||
color="#1A82E2"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[SendGrid](https://sendgrid.com) es una plataforma líder de envío de correos electrónicos en la nube en la que confían desarrolladores y empresas para enviar correos electrónicos transaccionales y de marketing fiables a gran escala. Con sus sólidas APIs y potentes herramientas, SendGrid te permite gestionar todos los aspectos de tu comunicación por correo electrónico, desde el envío de notificaciones y recibos hasta la gestión de complejas campañas de marketing.
|
||||
|
||||
SendGrid ofrece a los usuarios un conjunto completo de operaciones de correo electrónico, permitiéndote automatizar flujos de trabajo críticos de correo electrónico y gestionar de cerca listas de contactos, plantillas y la participación de los destinatarios. Su integración perfecta con Sim permite a los agentes y flujos de trabajo entregar mensajes específicos, mantener listas dinámicas de contactos y destinatarios, activar correos electrónicos personalizados a través de plantillas y seguir los resultados en tiempo real.
|
||||
|
||||
Las características principales de SendGrid incluyen:
|
||||
|
||||
- **Correo electrónico transaccional:** Envía correos electrónicos transaccionales automatizados y de alto volumen (como notificaciones, recibos y restablecimientos de contraseña).
|
||||
- **Plantillas dinámicas:** Utiliza plantillas de texto o HTML enriquecido con datos dinámicos para una comunicación altamente personalizada a gran escala.
|
||||
- **Gestión de contactos:** Añade y actualiza contactos de marketing, gestiona listas de destinatarios y segmentos objetivo para campañas.
|
||||
- **Soporte para archivos adjuntos:** Incluye uno o más archivos adjuntos en tus correos electrónicos.
|
||||
- **Cobertura integral de API:** Gestiona programáticamente correos electrónicos, contactos, listas, plantillas, grupos de supresión y más.
|
||||
|
||||
Al conectar SendGrid con Sim, tus agentes pueden:
|
||||
|
||||
- Enviar correos electrónicos tanto simples como avanzados (con plantillas o múltiples destinatarios) como parte de cualquier flujo de trabajo.
|
||||
- Gestionar y segmentar contactos y listas automáticamente.
|
||||
- Aprovechar las plantillas para mantener consistencia y personalización dinámica.
|
||||
- Realizar seguimiento y responder a la interacción con los correos electrónicos dentro de tus procesos automatizados.
|
||||
|
||||
Esta integración te permite automatizar todos los flujos de comunicación críticos, asegurar que los mensajes lleguen a la audiencia correcta y mantener el control sobre la estrategia de correo electrónico de tu organización, directamente desde los flujos de trabajo de Sim.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra SendGrid en tu flujo de trabajo. Envía correos electrónicos transaccionales, gestiona contactos y listas de marketing, y trabaja con plantillas de correo electrónico. Compatible con plantillas dinámicas, archivos adjuntos y gestión integral de contactos.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `sendgrid_send_mail`
|
||||
|
||||
Enviar un correo electrónico usando la API de SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `from` | string | Sí | Dirección de correo electrónico del remitente \(debe estar verificada en SendGrid\) |
|
||||
| `fromName` | string | No | Nombre del remitente |
|
||||
| `to` | string | Sí | Dirección de correo electrónico del destinatario |
|
||||
| `toName` | string | No | Nombre del destinatario |
|
||||
| `subject` | string | No | Asunto del correo electrónico \(obligatorio a menos que se use una plantilla con asunto predefinido\) |
|
||||
| `content` | string | No | Contenido del cuerpo del correo electrónico \(obligatorio a menos que se use una plantilla con contenido predefinido\) |
|
||||
| `contentType` | string | No | Tipo de contenido \(text/plain o text/html\) |
|
||||
| `cc` | string | No | Dirección de correo electrónico CC |
|
||||
| `bcc` | string | No | Dirección de correo electrónico BCC |
|
||||
| `replyTo` | string | No | Dirección de correo electrónico de respuesta |
|
||||
| `replyToName` | string | No | Nombre de respuesta |
|
||||
| `attachments` | file[] | No | Archivos para adjuntar al correo electrónico |
|
||||
| `templateId` | string | No | ID de plantilla de SendGrid a utilizar |
|
||||
| `dynamicTemplateData` | json | No | Objeto JSON de datos de plantilla dinámica |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si el correo electrónico se envió correctamente |
|
||||
| `messageId` | string | ID del mensaje de SendGrid |
|
||||
| `to` | string | Dirección de correo electrónico del destinatario |
|
||||
| `subject` | string | Asunto del correo electrónico |
|
||||
|
||||
### `sendgrid_add_contact`
|
||||
|
||||
Añadir un nuevo contacto a SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `email` | string | Sí | Dirección de correo electrónico del contacto |
|
||||
| `firstName` | string | No | Nombre del contacto |
|
||||
| `lastName` | string | No | Apellido del contacto |
|
||||
| `customFields` | json | No | Objeto JSON de pares clave-valor de campos personalizados \(use IDs de campo como e1_T, e2_N, e3_D, no nombres de campo\) |
|
||||
| `listIds` | string | No | Lista separada por comas de IDs a los que añadir el contacto |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobId` | string | ID de trabajo para seguimiento de la creación asíncrona de contactos |
|
||||
| `email` | string | Dirección de correo electrónico del contacto |
|
||||
| `firstName` | string | Nombre del contacto |
|
||||
| `lastName` | string | Apellido del contacto |
|
||||
| `message` | string | Mensaje de estado |
|
||||
|
||||
### `sendgrid_get_contact`
|
||||
|
||||
Obtener un contacto específico por ID desde SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `contactId` | string | Sí | ID del contacto |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | ID del contacto |
|
||||
| `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 |
|
||||
|
||||
### `sendgrid_search_contacts`
|
||||
|
||||
Buscar contactos en SendGrid usando una consulta
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `query` | string | Sí | Consulta de búsqueda (p. ej., "email LIKE '%example.com%' AND CONTAINS(list_ids, 'list-id')") |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `contacts` | json | Array de contactos coincidentes |
|
||||
| `contactCount` | number | Número total de contactos encontrados |
|
||||
|
||||
### `sendgrid_delete_contacts`
|
||||
|
||||
Eliminar uno o más contactos de SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `contactIds` | string | Sí | IDs de contactos separados por comas para eliminar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobId` | string | ID de trabajo para la solicitud de eliminación |
|
||||
|
||||
### `sendgrid_create_list`
|
||||
|
||||
Crear una nueva lista de contactos en SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `name` | string | Sí | Nombre de la lista |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | ID de la lista |
|
||||
| `name` | string | Nombre de la lista |
|
||||
| `contactCount` | number | Número de contactos en la lista |
|
||||
|
||||
### `sendgrid_get_list`
|
||||
|
||||
Obtener una lista específica por ID desde SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `listId` | string | Sí | ID de la lista |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | ID de la lista |
|
||||
| `name` | string | Nombre de la lista |
|
||||
| `contactCount` | number | Número de contactos en la lista |
|
||||
|
||||
### `sendgrid_list_all_lists`
|
||||
|
||||
Obtener todas las listas de contactos desde SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `pageSize` | number | No | Número de listas a devolver por página \(predeterminado: 100\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `lists` | json | Array de listas |
|
||||
|
||||
### `sendgrid_delete_list`
|
||||
|
||||
Eliminar una lista de contactos de SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `listId` | string | Sí | ID de la lista a eliminar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `message` | string | Mensaje de éxito |
|
||||
|
||||
### `sendgrid_add_contacts_to_list`
|
||||
|
||||
Añadir o actualizar contactos y asignarlos a una lista en SendGrid (usa PUT /v3/marketing/contacts)
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `listId` | string | Sí | ID de la lista a la que añadir contactos |
|
||||
| `contacts` | json | Sí | Array JSON de objetos de contacto. Cada contacto debe tener al menos: email \(o phone_number_id/external_id/anonymous_id\). Ejemplo: \[\{"email": "user@example.com", "first_name": "John"\}\] |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobId` | string | ID del trabajo para seguimiento de la operación asíncrona |
|
||||
| `message` | string | Mensaje de estado |
|
||||
|
||||
### `sendgrid_remove_contacts_from_list`
|
||||
|
||||
Eliminar contactos de una lista específica en SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `listId` | string | Sí | ID de la lista |
|
||||
| `contactIds` | string | Sí | IDs de contactos separados por comas para eliminar de la lista |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `jobId` | string | ID del trabajo para la solicitud |
|
||||
|
||||
### `sendgrid_create_template`
|
||||
|
||||
Crear una nueva plantilla de correo electrónico en SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `name` | string | Sí | Nombre de la plantilla |
|
||||
| `generation` | string | No | Tipo de generación de plantilla \(legacy o dynamic, predeterminado: dynamic\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | ID de la plantilla |
|
||||
| `name` | string | Nombre de la plantilla |
|
||||
| `generation` | string | Generación de la plantilla |
|
||||
| `updatedAt` | string | Marca de tiempo de la última actualización |
|
||||
| `versions` | json | Array de versiones de la plantilla |
|
||||
|
||||
### `sendgrid_get_template`
|
||||
|
||||
Obtener una plantilla específica por ID desde SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `templateId` | string | Sí | ID de la plantilla |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | ID de la plantilla |
|
||||
| `name` | string | Nombre de la plantilla |
|
||||
| `generation` | string | Generación de la plantilla |
|
||||
| `updatedAt` | string | Marca de tiempo de la última actualización |
|
||||
| `versions` | json | Array de versiones de la plantilla |
|
||||
|
||||
### `sendgrid_list_templates`
|
||||
|
||||
Obtener todas las plantillas de correo electrónico de SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `generations` | string | No | Filtrar por generación \(legacy, dynamic, o ambas\) |
|
||||
| `pageSize` | number | No | Número de plantillas a devolver por página \(predeterminado: 20\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `templates` | json | Array de plantillas |
|
||||
|
||||
### `sendgrid_delete_template`
|
||||
|
||||
Eliminar una plantilla de correo electrónico de SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `templateId` | string | Sí | ID de la plantilla a eliminar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Estado de éxito de la operación |
|
||||
| `messageId` | string | ID del mensaje de correo electrónico \(send_mail\) |
|
||||
| `id` | string | ID del recurso |
|
||||
| `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 |
|
||||
| `templates` | json | Array de plantillas |
|
||||
| `message` | string | Estado o mensaje de éxito |
|
||||
| `name` | string | Nombre del recurso |
|
||||
| `generation` | string | Generación de plantilla |
|
||||
|
||||
### `sendgrid_create_template_version`
|
||||
|
||||
Crear una nueva versión de una plantilla de correo electrónico en SendGrid
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | string | Sí | Clave API de SendGrid |
|
||||
| `templateId` | string | Sí | ID de la plantilla |
|
||||
| `name` | string | Sí | Nombre de la versión |
|
||||
| `subject` | string | Sí | Línea de asunto del correo electrónico |
|
||||
| `htmlContent` | string | No | Contenido HTML de la plantilla |
|
||||
| `plainContent` | string | No | Contenido de texto plano de la plantilla |
|
||||
| `active` | boolean | No | Si esta versión está activa \(predeterminado: true\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | ID de la versión |
|
||||
| `templateId` | string | ID de la plantilla |
|
||||
| `name` | string | Nombre de la versión |
|
||||
| `subject` | string | Asunto del correo electrónico |
|
||||
| `active` | boolean | Si esta versión está activa |
|
||||
| `htmlContent` | string | Contenido HTML |
|
||||
| `plainContent` | string | Contenido de texto plano |
|
||||
| `updatedAt` | string | Marca de tiempo de la última actualización |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `sendgrid`
|
||||
444
apps/docs/content/docs/es/tools/shopify.mdx
Normal file
444
apps/docs/content/docs/es/tools/shopify.mdx
Normal file
@@ -0,0 +1,444 @@
|
||||
---
|
||||
title: Shopify
|
||||
description: Gestiona productos, pedidos, clientes e inventario en tu tienda Shopify
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="shopify"
|
||||
color="#FFFFFF"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Shopify](https://www.shopify.com/) es una plataforma líder de comercio electrónico diseñada para ayudar a los comerciantes a construir, administrar y hacer crecer sus tiendas en línea. Shopify facilita la gestión de todos los aspectos de tu tienda, desde productos e inventario hasta pedidos y clientes.
|
||||
|
||||
Con Shopify en Sim, tus agentes pueden:
|
||||
|
||||
- **Crear y gestionar productos**: Añadir nuevos productos, actualizar detalles de productos y eliminar productos de tu tienda.
|
||||
- **Listar y recuperar pedidos**: Obtener información sobre los pedidos de los clientes, incluyendo filtrado y gestión de pedidos.
|
||||
- **Gestionar clientes**: Acceder y actualizar detalles de clientes, o añadir nuevos clientes a tu tienda.
|
||||
- **Ajustar niveles de inventario**: Cambiar programáticamente los niveles de stock de productos para mantener tu inventario preciso.
|
||||
|
||||
Utiliza la integración de Shopify en Sim para automatizar flujos de trabajo comunes de gestión de tiendas, como sincronizar inventario, cumplir pedidos o gestionar listados, directamente desde tus automatizaciones. Permite a tus agentes acceder, actualizar y organizar todos los datos de tu tienda utilizando herramientas simples y programáticas.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra Shopify en tu flujo de trabajo. Gestiona productos, pedidos, clientes e inventario. Crea, lee, actualiza y elimina productos. Lista y gestiona pedidos. Maneja datos de clientes y ajusta niveles de inventario.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `shopify_create_product`
|
||||
|
||||
Crear un nuevo producto en tu tienda Shopify
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(ej., mitienda.myshopify.com\) |
|
||||
| `title` | string | Sí | Título del producto |
|
||||
| `descriptionHtml` | string | No | Descripción del producto \(HTML\) |
|
||||
| `vendor` | string | No | Proveedor/marca del producto |
|
||||
| `productType` | string | No | Tipo/categoría del producto |
|
||||
| `tags` | array | No | Etiquetas del producto |
|
||||
| `status` | string | No | Estado del producto \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `product` | object | El producto creado |
|
||||
|
||||
### `shopify_get_product`
|
||||
|
||||
Obtener un solo producto por ID de tu tienda Shopify
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `productId` | string | Sí | ID del producto \(gid://shopify/Product/123456789\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `product` | object | Los detalles del producto |
|
||||
|
||||
### `shopify_list_products`
|
||||
|
||||
Listar productos de tu tienda Shopify con filtrado opcional
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `first` | number | No | Número de productos a devolver \(predeterminado: 50, máximo: 250\) |
|
||||
| `query` | string | No | Consulta de búsqueda para filtrar productos \(p. ej., "title:camisa" o "vendor:Nike" o "status:active"\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `products` | array | Lista de productos |
|
||||
| `pageInfo` | object | Información de paginación |
|
||||
|
||||
### `shopify_update_product`
|
||||
|
||||
Actualizar un producto existente en tu tienda Shopify
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `productId` | string | Sí | ID del producto a actualizar \(gid://shopify/Product/123456789\) |
|
||||
| `title` | string | No | Nuevo título del producto |
|
||||
| `descriptionHtml` | string | No | Nueva descripción del producto \(HTML\) |
|
||||
| `vendor` | string | No | Nuevo proveedor/marca del producto |
|
||||
| `productType` | string | No | Nuevo tipo/categoría del producto |
|
||||
| `tags` | array | No | Nuevas etiquetas del producto |
|
||||
| `status` | string | No | Nuevo estado del producto \(ACTIVE, DRAFT, ARCHIVED\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `product` | objeto | El producto actualizado |
|
||||
|
||||
### `shopify_delete_product`
|
||||
|
||||
Eliminar un producto de tu tienda Shopify
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `productId` | string | Sí | ID del producto a eliminar \(gid://shopify/Product/123456789\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deletedId` | string | El ID del producto eliminado |
|
||||
|
||||
### `shopify_get_order`
|
||||
|
||||
Obtener un pedido individual por ID de tu tienda Shopify
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `orderId` | string | Sí | ID del pedido \(gid://shopify/Order/123456789\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | objeto | Los detalles del pedido |
|
||||
|
||||
### `shopify_list_orders`
|
||||
|
||||
Listar pedidos de tu tienda Shopify con filtrado opcional
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `first` | number | No | Número de pedidos a devolver \(predeterminado: 50, máximo: 250\) |
|
||||
| `status` | string | No | Filtrar por estado del pedido \(abierto, cerrado, cancelado, cualquiera\) |
|
||||
| `query` | string | No | Consulta de búsqueda para filtrar pedidos \(p. ej., "financial_status:paid" o "fulfillment_status:unfulfilled" o "email:customer@example.com"\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `orders` | array | Lista de pedidos |
|
||||
| `pageInfo` | object | Información de paginación |
|
||||
|
||||
### `shopify_update_order`
|
||||
|
||||
Actualizar un pedido existente en tu tienda Shopify (nota, etiquetas, correo electrónico)
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `orderId` | string | Sí | ID del pedido a actualizar \(gid://shopify/Order/123456789\) |
|
||||
| `note` | string | No | Nueva nota del pedido |
|
||||
| `tags` | array | No | Nuevas etiquetas del pedido |
|
||||
| `email` | string | No | Nuevo correo electrónico del cliente para el pedido |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | El pedido actualizado |
|
||||
|
||||
### `shopify_cancel_order`
|
||||
|
||||
Cancelar un pedido en tu tienda Shopify
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `orderId` | string | Sí | ID del pedido a cancelar \(gid://shopify/Order/123456789\) |
|
||||
| `reason` | string | Sí | Motivo de cancelación \(CUSTOMER, DECLINED, FRAUD, INVENTORY, STAFF, OTHER\) |
|
||||
| `notifyCustomer` | boolean | No | Si se debe notificar al cliente sobre la cancelación |
|
||||
| `refund` | boolean | No | Si se debe reembolsar el pedido |
|
||||
| `restock` | boolean | No | Si se debe reponer el inventario |
|
||||
| `staffNote` | string | No | Una nota sobre la cancelación para referencia del personal |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `order` | object | El resultado de la cancelación |
|
||||
|
||||
### `shopify_create_customer`
|
||||
|
||||
Crear un nuevo cliente en tu tienda Shopify
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `email` | string | No | Dirección de correo electrónico del cliente |
|
||||
| `firstName` | string | No | Nombre del cliente |
|
||||
| `lastName` | string | No | Apellido del cliente |
|
||||
| `phone` | string | No | Número de teléfono del cliente |
|
||||
| `note` | string | No | Nota sobre el cliente |
|
||||
| `tags` | array | No | Etiquetas del cliente |
|
||||
| `addresses` | array | No | Direcciones del cliente |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | El cliente creado |
|
||||
|
||||
### `shopify_get_customer`
|
||||
|
||||
Obtener un solo cliente por ID de tu tienda Shopify
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `customerId` | string | Sí | ID del cliente \(gid://shopify/Customer/123456789\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | Los detalles del cliente |
|
||||
|
||||
### `shopify_list_customers`
|
||||
|
||||
Lista los clientes de tu tienda Shopify con filtrado opcional
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(ej., mitienda.myshopify.com\) |
|
||||
| `first` | number | No | Número de clientes a devolver \(predeterminado: 50, máximo: 250\) |
|
||||
| `query` | string | No | Consulta de búsqueda para filtrar clientes \(ej., "first_name:John" o "last_name:Smith" o "email:*@gmail.com" o "tag:vip"\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customers` | array | Lista de clientes |
|
||||
| `pageInfo` | object | Información de paginación |
|
||||
|
||||
### `shopify_update_customer`
|
||||
|
||||
Actualiza un cliente existente en tu tienda Shopify
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(ej., mitienda.myshopify.com\) |
|
||||
| `customerId` | string | Sí | ID del cliente a actualizar \(gid://shopify/Customer/123456789\) |
|
||||
| `email` | string | No | Nueva dirección de correo electrónico del cliente |
|
||||
| `firstName` | string | No | Nuevo nombre del cliente |
|
||||
| `lastName` | string | No | Nuevo apellido del cliente |
|
||||
| `phone` | string | No | Nuevo número de teléfono del cliente |
|
||||
| `note` | string | No | Nueva nota sobre el cliente |
|
||||
| `tags` | array | No | Nuevas etiquetas del cliente |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `customer` | object | El cliente actualizado |
|
||||
|
||||
### `shopify_delete_customer`
|
||||
|
||||
Eliminar un cliente de tu tienda Shopify
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(ej., mitienda.myshopify.com\) |
|
||||
| `customerId` | string | Sí | ID del cliente a eliminar \(gid://shopify/Customer/123456789\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deletedId` | string | El ID del cliente eliminado |
|
||||
|
||||
### `shopify_list_inventory_items`
|
||||
|
||||
Listar artículos de inventario de tu tienda Shopify. Utiliza esto para encontrar IDs de artículos de inventario por SKU.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(ej., mitienda.myshopify.com\) |
|
||||
| `first` | number | No | Número de artículos de inventario a devolver \(predeterminado: 50, máximo: 250\) |
|
||||
| `query` | string | No | Consulta de búsqueda para filtrar artículos de inventario \(ej., "sku:ABC123"\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `inventoryItems` | array | Lista de artículos de inventario con sus IDs, SKUs y niveles de stock |
|
||||
| `pageInfo` | object | Información de paginación |
|
||||
|
||||
### `shopify_get_inventory_level`
|
||||
|
||||
Obtener nivel de inventario para una variante de producto en una ubicación específica
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(ej., mitienda.myshopify.com\) |
|
||||
| `inventoryItemId` | string | Sí | ID del artículo de inventario \(gid://shopify/InventoryItem/123456789\) |
|
||||
| `locationId` | string | No | ID de ubicación para filtrar \(opcional\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `inventoryLevel` | object | Los detalles del nivel de inventario |
|
||||
|
||||
### `shopify_adjust_inventory`
|
||||
|
||||
Ajustar la cantidad de inventario para una variante de producto en una ubicación específica
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `inventoryItemId` | string | Sí | ID del artículo de inventario \(gid://shopify/InventoryItem/123456789\) |
|
||||
| `locationId` | string | Sí | ID de ubicación \(gid://shopify/Location/123456789\) |
|
||||
| `delta` | number | Sí | Cantidad a ajustar \(positivo para aumentar, negativo para disminuir\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `inventoryLevel` | object | El resultado del ajuste de inventario |
|
||||
|
||||
### `shopify_list_locations`
|
||||
|
||||
Listar ubicaciones de inventario de tu tienda Shopify. Utiliza esto para encontrar los IDs de ubicación necesarios para operaciones de inventario.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `first` | number | No | Número de ubicaciones a devolver \(predeterminado: 50, máximo: 250\) |
|
||||
| `includeInactive` | boolean | No | Si se deben incluir ubicaciones desactivadas \(predeterminado: false\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `locations` | array | Lista de ubicaciones con sus IDs, nombres y direcciones |
|
||||
| `pageInfo` | object | Información de paginación |
|
||||
|
||||
### `shopify_create_fulfillment`
|
||||
|
||||
Crea un envío para marcar los artículos del pedido como enviados. Requiere un ID de orden de envío (obtén esto desde los detalles del pedido).
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(ej., mitienda.myshopify.com\) |
|
||||
| `fulfillmentOrderId` | string | Sí | El ID de la orden de envío \(ej., gid://shopify/FulfillmentOrder/123456789\) |
|
||||
| `trackingNumber` | string | No | Número de seguimiento para el envío |
|
||||
| `trackingCompany` | string | No | Nombre del transportista \(ej., UPS, FedEx, USPS, DHL\) |
|
||||
| `trackingUrl` | string | No | URL para rastrear el envío |
|
||||
| `notifyCustomer` | boolean | No | Si se debe enviar un correo electrónico de confirmación de envío al cliente \(predeterminado: true\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `fulfillment` | object | El envío creado con información de seguimiento y artículos enviados |
|
||||
|
||||
### `shopify_list_collections`
|
||||
|
||||
Lista las colecciones de productos de tu tienda Shopify. Filtra por título, tipo (personalizada/inteligente) o identificador.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(ej., mitienda.myshopify.com\) |
|
||||
| `first` | number | No | Número de colecciones a devolver \(predeterminado: 50, máx: 250\) |
|
||||
| `query` | string | No | Consulta de búsqueda para filtrar colecciones \(ej., "title:Verano" o "collection_type:smart"\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `collections` | array | Lista de colecciones con sus IDs, títulos y recuentos de productos |
|
||||
| `pageInfo` | object | Información de paginación |
|
||||
|
||||
### `shopify_get_collection`
|
||||
|
||||
Obtén una colección específica por ID, incluyendo sus productos. Usa esto para recuperar productos dentro de una colección.
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `shopDomain` | string | Sí | El dominio de tu tienda Shopify \(p. ej., mitienda.myshopify.com\) |
|
||||
| `collectionId` | string | Sí | El ID de la colección \(p. ej., gid://shopify/Collection/123456789\) |
|
||||
| `productsFirst` | number | No | Número de productos a devolver de esta colección \(predeterminado: 50, máx: 250\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `collection` | object | Los detalles de la colección incluyendo sus productos |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `shopify`
|
||||
73
apps/docs/content/docs/es/tools/smtp.mdx
Normal file
73
apps/docs/content/docs/es/tools/smtp.mdx
Normal file
@@ -0,0 +1,73 @@
|
||||
---
|
||||
title: SMTP
|
||||
description: Envía correos electrónicos a través de cualquier servidor de correo SMTP
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="smtp"
|
||||
color="#4A5568"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[SMTP (Simple Mail Transfer Protocol)](https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol) es el estándar fundamental para la transmisión de correos electrónicos a través de Internet. Al conectarte a cualquier servidor compatible con SMTP—como Gmail, Outlook, o la infraestructura de correo de tu organización—puedes enviar correos electrónicos de forma programática y automatizar tus comunicaciones salientes.
|
||||
|
||||
La integración SMTP te permite personalizar completamente el envío de correos electrónicos mediante conectividad directa con el servidor, admitiendo casos de uso de correo electrónico tanto básicos como avanzados. Con SMTP, puedes controlar todos los aspectos de la entrega de mensajes, la gestión de destinatarios y el formato del contenido, lo que lo hace adecuado para notificaciones transaccionales, envíos masivos y cualquier flujo de trabajo automatizado que requiera una entrega robusta de correos electrónicos salientes.
|
||||
|
||||
**Las características clave disponibles a través de la integración SMTP incluyen:**
|
||||
|
||||
- **Entrega universal de correos electrónicos:** Envía correos electrónicos utilizando cualquier servidor SMTP configurando parámetros estándar de conexión al servidor.
|
||||
- **Remitente y destinatarios personalizables:** Especifica la dirección del remitente, el nombre para mostrar, los destinatarios principales, así como los campos CC y CCO.
|
||||
- **Soporte para contenido enriquecido:** Envía correos electrónicos de texto plano o con formato HTML enriquecido según tus requisitos.
|
||||
- **Archivos adjuntos:** Incluye múltiples archivos como adjuntos en los correos electrónicos salientes.
|
||||
- **Seguridad flexible:** Conéctate usando protocolos TLS, SSL o estándar (sin cifrar) según lo admita tu proveedor SMTP.
|
||||
- **Encabezados avanzados:** Configura encabezados de respuesta y otras opciones avanzadas de correo electrónico para atender flujos de correo complejos e interacciones de usuario.
|
||||
|
||||
Al integrar SMTP con Sim, los agentes y flujos de trabajo pueden enviar correos electrónicos de forma programática como parte de cualquier proceso automatizado—desde el envío de notificaciones y confirmaciones, hasta la automatización de comunicaciones externas, informes y entrega de documentos. Esto ofrece un enfoque altamente flexible e independiente del proveedor para gestionar el correo electrónico directamente dentro de tus procesos impulsados por IA.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Envía correos electrónicos utilizando cualquier servidor SMTP (Gmail, Outlook, servidores personalizados, etc.). Configura los ajustes de conexión SMTP y envía correos electrónicos con control total sobre el contenido, destinatarios y archivos adjuntos.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `smtp_send_mail`
|
||||
|
||||
Enviar correos electrónicos a través del servidor SMTP
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `smtpHost` | string | Sí | Nombre del host del servidor SMTP \(p. ej., smtp.gmail.com\) |
|
||||
| `smtpPort` | number | Sí | Puerto del servidor SMTP \(587 para TLS, 465 para SSL\) |
|
||||
| `smtpUsername` | string | Sí | Nombre de usuario para autenticación SMTP |
|
||||
| `smtpPassword` | string | Sí | Contraseña para autenticación SMTP |
|
||||
| `smtpSecure` | string | Sí | Protocolo de seguridad \(TLS, SSL o Ninguno\) |
|
||||
| `from` | string | Sí | Dirección de correo electrónico del remitente |
|
||||
| `to` | string | Sí | Dirección de correo electrónico del destinatario |
|
||||
| `subject` | string | Sí | Asunto del correo electrónico |
|
||||
| `body` | string | Sí | Contenido del cuerpo del correo electrónico |
|
||||
| `contentType` | string | No | Tipo de contenido \(texto o html\) |
|
||||
| `fromName` | string | No | Nombre para mostrar del remitente |
|
||||
| `cc` | string | No | Destinatarios en CC \(separados por comas\) |
|
||||
| `bcc` | string | No | Destinatarios en CCO \(separados por comas\) |
|
||||
| `replyTo` | string | No | Dirección de correo electrónico de respuesta |
|
||||
| `attachments` | file[] | No | Archivos para adjuntar al correo electrónico |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si el correo electrónico se envió correctamente |
|
||||
| `messageId` | string | ID del mensaje del servidor SMTP |
|
||||
| `to` | string | Dirección de correo electrónico del destinatario |
|
||||
| `subject` | string | Asunto del correo electrónico |
|
||||
| `error` | string | Mensaje de error si el envío falló |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `smtp`
|
||||
394
apps/docs/content/docs/es/tools/ssh.mdx
Normal file
394
apps/docs/content/docs/es/tools/ssh.mdx
Normal file
@@ -0,0 +1,394 @@
|
||||
---
|
||||
title: SSH
|
||||
description: Conéctate a servidores remotos vía SSH
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="ssh"
|
||||
color="#000000"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[SSH (Secure Shell)](https://en.wikipedia.org/wiki/Secure_Shell) es un protocolo ampliamente utilizado para conectarse de forma segura a servidores remotos, permitiéndote ejecutar comandos, transferir archivos y gestionar sistemas a través de canales cifrados.
|
||||
|
||||
Con el soporte SSH en Sim, tus agentes pueden:
|
||||
|
||||
- **Ejecutar comandos remotos**: Ejecuta comandos de shell en cualquier servidor accesible por SSH
|
||||
- **Subir y ejecutar scripts**: Transfiere y ejecuta fácilmente scripts de múltiples líneas para automatización avanzada
|
||||
- **Transferir archivos de forma segura**: Sube y descarga archivos como parte de tus flujos de trabajo (próximamente o mediante comando)
|
||||
- **Automatizar la gestión de servidores**: Realiza actualizaciones, mantenimiento, monitoreo, despliegues y tareas de configuración de forma programática
|
||||
- **Usar autenticación flexible**: Conéctate con autenticación por contraseña o clave privada, incluyendo soporte para claves cifradas
|
||||
|
||||
Las siguientes herramientas SSH de Sim permiten a tus agentes interactuar con servidores como parte de automatizaciones más amplias:
|
||||
|
||||
- `ssh_execute_command`: Ejecuta cualquier comando shell de forma remota y captura la salida, el estado y los errores.
|
||||
- `ssh_execute_script`: Sube y ejecuta un script completo de múltiples líneas en el sistema remoto.
|
||||
- (Próximamente herramientas adicionales, como la transferencia de archivos).
|
||||
|
||||
Al integrar SSH en los flujos de trabajo de tus agentes, puedes automatizar el acceso seguro, las operaciones remotas y la orquestación de servidores, agilizando DevOps, automatización de TI y gestión remota personalizada, todo desde Sim.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Ejecuta comandos, transfiere archivos y gestiona servidores remotos vía SSH. Compatible con autenticación por contraseña y clave privada para acceso seguro al servidor.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `ssh_execute_command`
|
||||
|
||||
Ejecuta un comando shell en un servidor SSH remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 |
|
||||
| `command` | string | Sí | Comando shell para ejecutar en el servidor remoto |
|
||||
| `workingDirectory` | string | No | Directorio de trabajo para la ejecución del comando |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `stdout` | string | Salida estándar del comando |
|
||||
| `stderr` | string | Salida de error estándar |
|
||||
| `exitCode` | number | Código de salida del comando |
|
||||
| `success` | boolean | Si el comando tuvo éxito \(código de salida 0\) |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `ssh_execute_script`
|
||||
|
||||
Subir y ejecutar un script de múltiples líneas en un servidor SSH remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 |
|
||||
| `script` | string | Sí | Contenido del script a ejecutar \(bash, python, etc.\) |
|
||||
| `interpreter` | string | No | Intérprete del script \(predeterminado: /bin/bash\) |
|
||||
| `workingDirectory` | string | No | Directorio de trabajo para la ejecución del script |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `stdout` | string | Salida estándar del script |
|
||||
| `stderr` | string | Salida de error estándar |
|
||||
| `exitCode` | number | Código de salida del script |
|
||||
| `success` | boolean | Si el script tuvo éxito \(código de salida 0\) |
|
||||
| `scriptPath` | string | Ruta temporal donde se subió el script |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `ssh_check_command_exists`
|
||||
|
||||
Comprobar si un comando/programa existe en el servidor SSH remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 |
|
||||
| `commandName` | string | Sí | Nombre del comando a comprobar \(p. ej., docker, git, python3\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `commandExists` | boolean | Si el comando existe o no |
|
||||
| `commandPath` | string | Ruta completa al comando \(si se encuentra\) |
|
||||
| `version` | string | Salida de la versión del comando \(si es aplicable\) |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `ssh_upload_file`
|
||||
|
||||
Subir un archivo a un servidor SSH remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 |
|
||||
| `fileContent` | string | Sí | Contenido del archivo a subir \(codificado en base64 para archivos binarios\) |
|
||||
| `fileName` | string | Sí | Nombre del archivo que se está subiendo |
|
||||
| `remotePath` | string | Sí | Ruta de destino en el servidor remoto |
|
||||
| `permissions` | string | No | Permisos del archivo \(p. ej., 0644\) |
|
||||
| `overwrite` | boolean | No | Si se deben sobrescribir archivos existentes \(predeterminado: true\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `uploaded` | boolean | Indica si el archivo se subió correctamente |
|
||||
| `remotePath` | string | Ruta final en el servidor remoto |
|
||||
| `size` | number | Tamaño del archivo en bytes |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `ssh_download_file`
|
||||
|
||||
Descargar un archivo desde un servidor SSH remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 archivo en el servidor remoto |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `downloaded` | boolean | Indica si el archivo se descargó correctamente |
|
||||
| `fileContent` | string | Contenido del archivo \(codificado en base64 para archivos binarios\) |
|
||||
| `fileName` | string | Nombre del archivo descargado |
|
||||
| `remotePath` | string | Ruta de origen en el servidor remoto |
|
||||
| `size` | number | Tamaño del archivo en bytes |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `ssh_list_directory`
|
||||
|
||||
Listar archivos y directorios en un directorio remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 |
|
||||
| `path` | string | Sí | Ruta del directorio remoto a listar |
|
||||
| `detailed` | boolean | No | Incluir detalles del archivo \(tamaño, permisos, fecha de modificación\) |
|
||||
| `recursive` | boolean | No | Listar subdirectorios recursivamente \(predeterminado: false\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `entries` | array | Array de entradas de archivos y directorios |
|
||||
|
||||
### `ssh_check_file_exists`
|
||||
|
||||
Comprobar si un archivo o directorio existe en el servidor SSH remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 |
|
||||
| `path` | string | Sí | Ruta del archivo o directorio remoto a comprobar |
|
||||
| `type` | string | No | Tipo esperado: archivo, directorio o cualquiera \(predeterminado: cualquiera\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `exists` | boolean | Si la ruta existe |
|
||||
| `type` | string | Tipo de ruta (archivo, directorio, enlace simbólico, no_encontrado) |
|
||||
| `size` | number | Tamaño del archivo si es un archivo |
|
||||
| `permissions` | string | Permisos del archivo (p. ej., 0755) |
|
||||
| `modified` | string | Marca de tiempo de última modificación |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `ssh_create_directory`
|
||||
|
||||
Crear un directorio en el servidor SSH remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH (predeterminado: 22) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 |
|
||||
| `path` | string | Sí | Ruta del directorio a crear |
|
||||
| `recursive` | boolean | No | Crear directorios padre si no existen (predeterminado: true) |
|
||||
| `permissions` | string | No | Permisos del directorio (predeterminado: 0755) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `created` | boolean | Si el directorio se creó correctamente |
|
||||
| `remotePath` | string | Ruta del directorio creado |
|
||||
| `alreadyExists` | boolean | Si el directorio ya existía |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `ssh_delete_file`
|
||||
|
||||
Eliminar un archivo o directorio del servidor SSH remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 |
|
||||
| `path` | string | Sí | Ruta a eliminar |
|
||||
| `recursive` | boolean | No | Eliminar directorios recursivamente \(predeterminado: false\) |
|
||||
| `force` | boolean | No | Forzar eliminación sin confirmación \(predeterminado: false\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Si la ruta se eliminó correctamente |
|
||||
| `remotePath` | string | Ruta eliminada |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `ssh_move_rename`
|
||||
|
||||
Mover o renombrar un archivo o directorio en el servidor SSH remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 |
|
||||
| `sourcePath` | string | Sí | Ruta actual del archivo o directorio |
|
||||
| `destinationPath` | string | Sí | Nueva ruta para el archivo o directorio |
|
||||
| `overwrite` | boolean | No | Sobrescribir destino si existe \(predeterminado: false\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `moved` | boolean | Si la operación fue exitosa |
|
||||
| `sourcePath` | string | Ruta original |
|
||||
| `destinationPath` | string | Nueva ruta |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `ssh_get_system_info`
|
||||
|
||||
Obtener información del sistema desde el servidor SSH remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Requerido | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `hostname` | string | Nombre de host del servidor |
|
||||
| `os` | string | Sistema operativo \(p. ej., Linux, Darwin\) |
|
||||
| `architecture` | string | Arquitectura de CPU \(p. ej., x64, arm64\) |
|
||||
| `uptime` | number | Tiempo de actividad del sistema en segundos |
|
||||
| `memory` | json | Información de memoria \(total, libre, usada\) |
|
||||
| `diskSpace` | json | Información de espacio en disco \(total, libre, usado\) |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `ssh_read_file_content`
|
||||
|
||||
Leer el contenido de un archivo remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 |
|
||||
| `path` | string | Sí | Ruta del archivo remoto a leer |
|
||||
| `encoding` | string | No | Codificación del archivo \(predeterminado: utf-8\) |
|
||||
| `maxSize` | number | No | Tamaño máximo de archivo a leer en MB \(predeterminado: 10\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `content` | string | Contenido del archivo como cadena de texto |
|
||||
| `size` | number | Tamaño del archivo en bytes |
|
||||
| `lines` | number | Número de líneas en el archivo |
|
||||
| `remotePath` | string | Ruta del archivo remoto |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
### `ssh_write_file_content`
|
||||
|
||||
Escribir o añadir contenido a un archivo remoto
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `host` | string | Sí | Nombre de host o dirección IP del servidor SSH |
|
||||
| `port` | number | Sí | Puerto del servidor SSH \(predeterminado: 22\) |
|
||||
| `username` | string | Sí | Nombre de usuario SSH |
|
||||
| `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 |
|
||||
| `path` | string | Sí | Ruta del archivo remoto donde escribir |
|
||||
| `content` | string | Sí | Contenido a escribir en el archivo |
|
||||
| `mode` | string | No | Modo de escritura: sobrescribir, añadir o crear \(predeterminado: sobrescribir\) |
|
||||
| `permissions` | string | No | Permisos del archivo \(p. ej., 0644\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `written` | boolean | Si el archivo se escribió correctamente |
|
||||
| `remotePath` | string | Ruta del archivo |
|
||||
| `size` | number | Tamaño final del archivo en bytes |
|
||||
| `message` | string | Mensaje de estado de la operación |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `ssh`
|
||||
566
apps/docs/content/docs/es/tools/wordpress.mdx
Normal file
566
apps/docs/content/docs/es/tools/wordpress.mdx
Normal file
@@ -0,0 +1,566 @@
|
||||
---
|
||||
title: WordPress
|
||||
description: Gestionar contenido de WordPress
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="wordpress"
|
||||
color="#21759B"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[WordPress](https://wordpress.org/) es el sistema de gestión de contenido de código abierto líder en el mundo, que facilita la publicación y gestión de sitios web, blogs y todo tipo de contenido en línea. Con WordPress, puedes crear y actualizar entradas o páginas, organizar tu contenido con categorías y etiquetas, gestionar archivos multimedia, moderar comentarios y administrar cuentas de usuario, lo que te permite ejecutar desde blogs personales hasta sitios web empresariales complejos.
|
||||
|
||||
La integración de Sim con WordPress permite a tus agentes automatizar tareas esenciales del sitio web. Puedes crear programáticamente nuevas entradas de blog con títulos específicos, contenido, categorías, etiquetas e imágenes destacadas. Actualizar entradas existentes —como cambiar su contenido, título o estado de publicación— es sencillo. También puedes publicar o guardar contenido como borradores, gestionar páginas estáticas, trabajar con cargas multimedia, supervisar comentarios y asignar contenido a taxonomías organizativas relevantes.
|
||||
|
||||
Al conectar WordPress con tus automatizaciones, Sim permite a tus agentes agilizar la publicación de contenido, los flujos de trabajo editoriales y la gestión diaria del sitio, ayudándote a mantener tu sitio web actualizado, organizado y seguro sin esfuerzo manual.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Intégrate con WordPress para crear, actualizar y gestionar entradas, páginas, multimedia, comentarios, categorías, etiquetas y usuarios. Compatible con sitios de WordPress.com mediante OAuth y sitios de WordPress autoalojados utilizando autenticación de Contraseñas de Aplicación.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `wordpress_create_post`
|
||||
|
||||
Crear una nueva entrada de blog en WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `title` | string | Sí | Título de la entrada |
|
||||
| `content` | string | No | Contenido de la entrada \(HTML o texto plano\) |
|
||||
| `status` | string | No | Estado de la entrada: publish, draft, pending, private o future |
|
||||
| `excerpt` | string | No | Extracto de la entrada |
|
||||
| `categories` | string | No | IDs de categorías separados por comas |
|
||||
| `tags` | string | No | IDs de etiquetas separados por comas |
|
||||
| `featuredMedia` | number | No | ID del medio de la imagen destacada |
|
||||
| `slug` | string | No | Slug de URL para la entrada |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `post` | object | La entrada creada |
|
||||
|
||||
### `wordpress_update_post`
|
||||
|
||||
Actualizar una entrada de blog existente en WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `postId` | number | Sí | El ID de la entrada a actualizar |
|
||||
| `title` | string | No | Título de la entrada |
|
||||
| `content` | string | No | Contenido de la entrada \(HTML o texto plano\) |
|
||||
| `status` | string | No | Estado de la entrada: publish, draft, pending, private, o future |
|
||||
| `excerpt` | string | No | Extracto de la entrada |
|
||||
| `categories` | string | No | IDs de categorías separados por comas |
|
||||
| `tags` | string | No | IDs de etiquetas separados por comas |
|
||||
| `featuredMedia` | number | No | ID del archivo multimedia de la imagen destacada |
|
||||
| `slug` | string | No | URL slug para la entrada |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `post` | object | La entrada actualizada |
|
||||
|
||||
### `wordpress_delete_post`
|
||||
|
||||
Eliminar una entrada de blog de WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `postId` | number | Sí | El ID de la entrada a eliminar |
|
||||
| `force` | boolean | No | Omitir la papelera y forzar la eliminación permanente |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Indica si la publicación fue eliminada |
|
||||
| `post` | object | La publicación eliminada |
|
||||
|
||||
### `wordpress_get_post`
|
||||
|
||||
Obtener una sola publicación de blog de WordPress.com por ID
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `postId` | number | Sí | El ID de la publicación a recuperar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `post` | object | La publicación recuperada |
|
||||
|
||||
### `wordpress_list_posts`
|
||||
|
||||
Listar publicaciones de blog de WordPress.com con filtros opcionales
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `perPage` | number | No | Número de publicaciones por página \(predeterminado: 10, máx: 100\) |
|
||||
| `page` | number | No | Número de página para paginación |
|
||||
| `status` | string | No | Filtro de estado de publicación: publish, draft, pending, private |
|
||||
| `author` | number | No | Filtrar por ID de autor |
|
||||
| `categories` | string | No | IDs de categorías separados por comas para filtrar |
|
||||
| `tags` | string | No | IDs de etiquetas separados por comas para filtrar |
|
||||
| `search` | string | No | Término de búsqueda para filtrar publicaciones |
|
||||
| `orderBy` | string | No | Ordenar por campo: date, id, title, slug, modified |
|
||||
| `order` | string | No | Dirección de ordenamiento: asc o desc |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `posts` | array | Lista de publicaciones |
|
||||
|
||||
### `wordpress_create_page`
|
||||
|
||||
Crear una nueva página en WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `title` | string | Sí | Título de la página |
|
||||
| `content` | string | No | Contenido de la página \(HTML o texto plano\) |
|
||||
| `status` | string | No | Estado de la página: publish, draft, pending, private |
|
||||
| `excerpt` | string | No | Extracto de la página |
|
||||
| `parent` | number | No | ID de la página padre para páginas jerárquicas |
|
||||
| `menuOrder` | number | No | Orden en el menú de páginas |
|
||||
| `featuredMedia` | number | No | ID del medio de la imagen destacada |
|
||||
| `slug` | string | No | Slug de URL para la página |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `page` | object | La página creada |
|
||||
|
||||
### `wordpress_update_page`
|
||||
|
||||
Actualizar una página existente en WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `pageId` | number | Sí | El ID de la página a actualizar |
|
||||
| `title` | string | No | Título de la página |
|
||||
| `content` | string | No | Contenido de la página \(HTML o texto plano\) |
|
||||
| `status` | string | No | Estado de la página: publish, draft, pending, private |
|
||||
| `excerpt` | string | No | Extracto de la página |
|
||||
| `parent` | number | No | ID de la página padre para páginas jerárquicas |
|
||||
| `menuOrder` | number | No | Orden en el menú de páginas |
|
||||
| `featuredMedia` | number | No | ID del medio de la imagen destacada |
|
||||
| `slug` | string | No | Slug de URL para la página |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `page` | objeto | La página actualizada |
|
||||
|
||||
### `wordpress_delete_page`
|
||||
|
||||
Eliminar una página de WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | cadena | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `pageId` | número | Sí | El ID de la página a eliminar |
|
||||
| `force` | booleano | No | Omitir la papelera y forzar la eliminación permanente |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | booleano | Si la página fue eliminada |
|
||||
| `page` | objeto | La página eliminada |
|
||||
|
||||
### `wordpress_get_page`
|
||||
|
||||
Obtener una sola página de WordPress.com por ID
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | cadena | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `pageId` | número | Sí | El ID de la página a recuperar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `page` | objeto | La página recuperada |
|
||||
|
||||
### `wordpress_list_pages`
|
||||
|
||||
Listar páginas de WordPress.com con filtros opcionales
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | cadena | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `perPage` | número | No | Número de páginas por solicitud \(predeterminado: 10, máx: 100\) |
|
||||
| `page` | número | No | Número de página para paginación |
|
||||
| `status` | cadena | No | Filtro de estado de página: publish, draft, pending, private |
|
||||
| `parent` | número | No | Filtrar por ID de página padre |
|
||||
| `search` | cadena | No | Término de búsqueda para filtrar páginas |
|
||||
| `orderBy` | cadena | No | Ordenar por campo: date, id, title, slug, modified, menu_order |
|
||||
| `order` | cadena | No | Dirección de ordenamiento: asc o desc |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pages` | array | Lista de páginas |
|
||||
|
||||
### `wordpress_upload_media`
|
||||
|
||||
Subir un archivo multimedia (imagen, video, documento) a WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| 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` | 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 archivo multimedia |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `media` | object | El elemento multimedia subido |
|
||||
|
||||
### `wordpress_get_media`
|
||||
|
||||
Obtener un solo elemento multimedia de WordPress.com por ID
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `mediaId` | number | Sí | El ID del elemento multimedia a recuperar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `media` | object | El elemento multimedia recuperado |
|
||||
|
||||
### `wordpress_list_media`
|
||||
|
||||
Listar elementos multimedia de la biblioteca multimedia de WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `perPage` | number | No | Número de elementos multimedia por solicitud \(predeterminado: 10, máx: 100\) |
|
||||
| `page` | number | No | Número de página para paginación |
|
||||
| `search` | string | No | Término de búsqueda para filtrar multimedia |
|
||||
| `mediaType` | string | No | Filtrar por tipo de multimedia: imagen, video, audio, aplicación |
|
||||
| `mimeType` | string | No | Filtrar por tipo MIME específico \(p. ej., image/jpeg\) |
|
||||
| `orderBy` | string | No | Ordenar por campo: fecha, id, título, slug |
|
||||
| `order` | string | No | Dirección de ordenamiento: asc o desc |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `media` | array | Lista de elementos multimedia |
|
||||
|
||||
### `wordpress_delete_media`
|
||||
|
||||
Eliminar un elemento multimedia de WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `mediaId` | number | Sí | El ID del elemento multimedia a eliminar |
|
||||
| `force` | boolean | No | Forzar eliminación \(los elementos multimedia no tienen papelera, por lo que la eliminación es permanente\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Si el medio fue eliminado |
|
||||
| `media` | object | El elemento multimedia eliminado |
|
||||
|
||||
### `wordpress_create_comment`
|
||||
|
||||
Crear un nuevo comentario en una entrada de WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `postId` | number | Sí | El ID de la entrada en la que comentar |
|
||||
| `content` | string | Sí | Contenido del comentario |
|
||||
| `parent` | number | No | ID del comentario padre para respuestas |
|
||||
| `authorName` | string | No | Nombre visible del autor del comentario |
|
||||
| `authorEmail` | string | No | Correo electrónico del autor del comentario |
|
||||
| `authorUrl` | string | No | URL del autor del comentario |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `comment` | object | El comentario creado |
|
||||
|
||||
### `wordpress_list_comments`
|
||||
|
||||
Listar comentarios de WordPress.com con filtros opcionales
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `perPage` | number | No | Número de comentarios por solicitud \(predeterminado: 10, máx: 100\) |
|
||||
| `page` | number | No | Número de página para paginación |
|
||||
| `postId` | number | No | Filtrar por ID de entrada |
|
||||
| `status` | string | No | Filtrar por estado del comentario: approved, hold, spam, trash |
|
||||
| `search` | string | No | Término de búsqueda para filtrar comentarios |
|
||||
| `orderBy` | string | No | Ordenar por campo: date, id, parent |
|
||||
| `order` | string | No | Dirección de ordenamiento: asc o desc |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `comments` | array | Lista de comentarios |
|
||||
|
||||
### `wordpress_update_comment`
|
||||
|
||||
Actualizar un comentario en WordPress.com (contenido o estado)
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `commentId` | number | Sí | El ID del comentario a actualizar |
|
||||
| `content` | string | No | Contenido actualizado del comentario |
|
||||
| `status` | string | No | Estado del comentario: approved, hold, spam, trash |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `comment` | object | El comentario actualizado |
|
||||
|
||||
### `wordpress_delete_comment`
|
||||
|
||||
Eliminar un comentario de WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `commentId` | number | Sí | El ID del comentario a eliminar |
|
||||
| `force` | boolean | No | Omitir la papelera y forzar la eliminación permanente |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `deleted` | boolean | Si el comentario fue eliminado |
|
||||
| `comment` | object | El comentario eliminado |
|
||||
|
||||
### `wordpress_create_category`
|
||||
|
||||
Crear una nueva categoría en WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com (p. ej., 12345678 o misitio.wordpress.com) |
|
||||
| `name` | string | Sí | Nombre de la categoría |
|
||||
| `description` | string | No | Descripción de la categoría |
|
||||
| `parent` | number | No | ID de la categoría padre para categorías jerárquicas |
|
||||
| `slug` | string | No | Slug de URL para la categoría |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `category` | object | La categoría creada |
|
||||
|
||||
### `wordpress_list_categories`
|
||||
|
||||
Listar categorías de WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com (p. ej., 12345678 o misitio.wordpress.com) |
|
||||
| `perPage` | number | No | Número de categorías por solicitud (predeterminado: 10, máx: 100) |
|
||||
| `page` | number | No | Número de página para paginación |
|
||||
| `search` | string | No | Término de búsqueda para filtrar categorías |
|
||||
| `order` | string | No | Dirección de ordenamiento: asc o desc |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `categories` | array | Lista de categorías |
|
||||
|
||||
### `wordpress_create_tag`
|
||||
|
||||
Crear una nueva etiqueta en WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com (p. ej., 12345678 o misitio.wordpress.com) |
|
||||
| `name` | string | Sí | Nombre de la etiqueta |
|
||||
| `description` | string | No | Descripción de la etiqueta |
|
||||
| `slug` | string | No | Slug de URL para la etiqueta |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tag` | object | La etiqueta creada |
|
||||
|
||||
### `wordpress_list_tags`
|
||||
|
||||
Listar etiquetas de WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `perPage` | number | No | Número de etiquetas por solicitud \(predeterminado: 10, máx: 100\) |
|
||||
| `page` | number | No | Número de página para paginación |
|
||||
| `search` | string | No | Término de búsqueda para filtrar etiquetas |
|
||||
| `order` | string | No | Dirección de ordenamiento: asc o desc |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `tags` | array | Lista de etiquetas |
|
||||
|
||||
### `wordpress_get_current_user`
|
||||
|
||||
Obtener información sobre el usuario autenticado actualmente en WordPress.com
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | El usuario actual |
|
||||
|
||||
### `wordpress_list_users`
|
||||
|
||||
Listar usuarios de WordPress.com (requiere privilegios de administrador)
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `perPage` | number | No | Número de usuarios por solicitud \(predeterminado: 10, máx: 100\) |
|
||||
| `page` | number | No | Número de página para paginación |
|
||||
| `search` | string | No | Término de búsqueda para filtrar usuarios |
|
||||
| `roles` | string | No | Nombres de roles separados por comas para filtrar |
|
||||
| `order` | string | No | Dirección de ordenamiento: asc o desc |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `users` | array | Lista de usuarios |
|
||||
|
||||
### `wordpress_get_user`
|
||||
|
||||
Obtener un usuario específico de WordPress.com por ID
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `userId` | number | Sí | El ID del usuario a recuperar |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `user` | object | El usuario recuperado |
|
||||
|
||||
### `wordpress_search_content`
|
||||
|
||||
Buscar en todos los tipos de contenido en WordPress.com (entradas, páginas, multimedia)
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `siteId` | string | Sí | ID del sitio o dominio de WordPress.com \(p. ej., 12345678 o misitio.wordpress.com\) |
|
||||
| `query` | string | Sí | Consulta de búsqueda |
|
||||
| `perPage` | number | No | Número de resultados por solicitud \(predeterminado: 10, máx: 100\) |
|
||||
| `page` | number | No | Número de página para paginación |
|
||||
| `type` | string | No | Filtrar por tipo de contenido: post, page, attachment |
|
||||
| `subtype` | string | No | Filtrar por slug de tipo de entrada \(p. ej., post, page\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `results` | array | Resultados de búsqueda |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `wordpress`
|
||||
@@ -114,6 +114,9 @@ Crear un nuevo ticket en Zendesk con soporte para campos personalizados
|
||||
| `type` | string | No | Tipo \(problem, incident, question, task\) |
|
||||
| `tags` | string | No | Etiquetas separadas por comas |
|
||||
| `assigneeId` | string | No | ID de usuario asignado |
|
||||
| `groupId` | string | No | ID del grupo |
|
||||
| `requesterId` | string | No | ID de usuario solicitante |
|
||||
| `customFields` | string | No | Campos personalizados como objeto JSON \(p. ej., \{"field_id": "value"\}\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
|
||||
250
apps/docs/content/docs/es/tools/zoom.mdx
Normal file
250
apps/docs/content/docs/es/tools/zoom.mdx
Normal file
@@ -0,0 +1,250 @@
|
||||
---
|
||||
title: Zoom
|
||||
description: Crea y gestiona reuniones y grabaciones de Zoom
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="zoom"
|
||||
color="#2D8CFF"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Zoom](https://zoom.us/) es una plataforma líder de comunicaciones basada en la nube para videoconferencias, webinars y colaboración en línea. Permite a usuarios y organizaciones programar, organizar y gestionar reuniones fácilmente, proporcionando herramientas para compartir pantalla, chat, grabaciones y más.
|
||||
|
||||
Con Zoom, puedes:
|
||||
|
||||
- **Programar y gestionar reuniones**: Crear reuniones instantáneas o programadas, incluyendo eventos recurrentes
|
||||
- **Configurar opciones de reunión**: Establecer contraseñas de reunión, habilitar salas de espera y controlar el video/audio de los participantes
|
||||
- **Enviar invitaciones y compartir detalles**: Obtener invitaciones e información de reuniones para compartir fácilmente
|
||||
- **Obtener y actualizar datos de reuniones**: Acceder a detalles de reuniones, modificar reuniones existentes y gestionar configuraciones de forma programática
|
||||
|
||||
En Sim, la integración con Zoom permite a tus agentes automatizar la programación y gestión de reuniones. Usa acciones de herramientas para:
|
||||
|
||||
- Crear programáticamente nuevas reuniones con configuraciones personalizadas
|
||||
- Listar todas las reuniones para un usuario específico (o para ti mismo)
|
||||
- Obtener detalles o invitaciones para cualquier reunión
|
||||
- Actualizar o eliminar reuniones existentes directamente desde tus automatizaciones
|
||||
|
||||
Estas capacidades te permiten agilizar la colaboración remota, automatizar sesiones de video recurrentes y gestionar el entorno Zoom de tu organización como parte de tus flujos de trabajo.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instrucciones de uso
|
||||
|
||||
Integra Zoom en flujos de trabajo. Crea, lista, actualiza y elimina reuniones de Zoom. Obtén detalles de reuniones, invitaciones, grabaciones y participantes. Gestiona grabaciones en la nube de forma programática.
|
||||
|
||||
## Herramientas
|
||||
|
||||
### `zoom_create_meeting`
|
||||
|
||||
Crear una nueva reunión de Zoom
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `userId` | string | Sí | El ID de usuario o dirección de correo electrónico. Usa "me" para el usuario autenticado. |
|
||||
| `topic` | string | Sí | Tema de la reunión |
|
||||
| `type` | number | No | Tipo de reunión: 1=instantánea, 2=programada, 3=recurrente sin hora fija, 8=recurrente con hora fija |
|
||||
| `startTime` | string | No | Hora de inicio de la reunión en formato ISO 8601 \(p. ej., 2025-06-03T10:00:00Z\) |
|
||||
| `duration` | number | No | Duración de la reunión en minutos |
|
||||
| `timezone` | string | No | Zona horaria para la reunión \(p. ej., America/Los_Angeles\) |
|
||||
| `password` | string | No | Contraseña de la reunión |
|
||||
| `agenda` | string | No | Agenda de la reunión |
|
||||
| `hostVideo` | boolean | No | Iniciar con video del anfitrión activado |
|
||||
| `participantVideo` | boolean | No | Iniciar con video de participantes activado |
|
||||
| `joinBeforeHost` | boolean | No | Permitir que los participantes se unan antes que el anfitrión |
|
||||
| `muteUponEntry` | boolean | No | Silenciar participantes al entrar |
|
||||
| `waitingRoom` | boolean | No | Habilitar sala de espera |
|
||||
| `autoRecording` | string | No | Configuración de grabación automática: local, cloud o none |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `meeting` | object | La reunión creada con todas sus propiedades |
|
||||
|
||||
### `zoom_list_meetings`
|
||||
|
||||
Listar todas las reuniones para un usuario de Zoom
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `userId` | string | Sí | El ID de usuario o dirección de correo electrónico. Use "me" para el usuario autenticado. |
|
||||
| `type` | string | No | Filtro de tipo de reunión: scheduled, live, upcoming, upcoming_meetings, o previous_meetings |
|
||||
| `pageSize` | number | No | Número de registros por página \(máximo 300\) |
|
||||
| `nextPageToken` | string | No | Token para paginación para obtener la siguiente página de resultados |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `meetings` | array | Lista de reuniones |
|
||||
| `pageInfo` | object | Información de paginación |
|
||||
|
||||
### `zoom_get_meeting`
|
||||
|
||||
Obtener detalles de una reunión específica de Zoom
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Sí | El ID de la reunión |
|
||||
| `occurrenceId` | string | No | ID de ocurrencia para reuniones recurrentes |
|
||||
| `showPreviousOccurrences` | boolean | No | Mostrar ocurrencias anteriores para reuniones recurrentes |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `meeting` | object | Los detalles de la reunión |
|
||||
|
||||
### `zoom_update_meeting`
|
||||
|
||||
Actualizar una reunión existente de Zoom
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Sí | El ID de la reunión a actualizar |
|
||||
| `topic` | string | No | Tema de la reunión |
|
||||
| `type` | number | No | Tipo de reunión: 1=instantánea, 2=programada, 3=recurrente sin hora fija, 8=recurrente con hora fija |
|
||||
| `startTime` | string | No | Hora de inicio de la reunión en formato ISO 8601 \(p. ej., 2025-06-03T10:00:00Z\) |
|
||||
| `duration` | number | No | Duración de la reunión en minutos |
|
||||
| `timezone` | string | No | Zona horaria para la reunión \(p. ej., America/Los_Angeles\) |
|
||||
| `password` | string | No | Contraseña de la reunión |
|
||||
| `agenda` | string | No | Agenda de la reunión |
|
||||
| `hostVideo` | boolean | No | Iniciar con video del anfitrión activado |
|
||||
| `participantVideo` | boolean | No | Iniciar con video de participantes activado |
|
||||
| `joinBeforeHost` | boolean | No | Permitir que los participantes se unan antes que el anfitrión |
|
||||
| `muteUponEntry` | boolean | No | Silenciar a los participantes al entrar |
|
||||
| `waitingRoom` | boolean | No | Habilitar sala de espera |
|
||||
| `autoRecording` | string | No | Configuración de grabación automática: local, en la nube o ninguna |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la reunión se actualizó correctamente |
|
||||
|
||||
### `zoom_delete_meeting`
|
||||
|
||||
Eliminar o cancelar una reunión de Zoom
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Sí | El ID de la reunión a eliminar |
|
||||
| `occurrenceId` | string | No | ID de ocurrencia para eliminar una ocurrencia específica de una reunión recurrente |
|
||||
| `scheduleForReminder` | boolean | No | Enviar correo electrónico de recordatorio de cancelación a los inscritos |
|
||||
| `cancelMeetingReminder` | boolean | No | Enviar correo electrónico de cancelación a los inscritos y anfitriones alternativos |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Indica si la reunión se eliminó correctamente |
|
||||
|
||||
### `zoom_get_meeting_invitation`
|
||||
|
||||
Obtener el texto de invitación para una reunión de Zoom
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Sí | El ID de la reunión |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `invitation` | string | El texto de invitación de la reunión |
|
||||
|
||||
### `zoom_list_recordings`
|
||||
|
||||
Listar todas las grabaciones en la nube para un usuario de Zoom
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `userId` | string | Sí | El ID de usuario o dirección de correo electrónico. Use "me" para el usuario autenticado. |
|
||||
| `from` | string | No | Fecha de inicio en formato aaaa-mm-dd \(dentro de los últimos 6 meses\) |
|
||||
| `to` | string | No | Fecha de fin en formato aaaa-mm-dd |
|
||||
| `pageSize` | number | No | Número de registros por página \(máximo 300\) |
|
||||
| `nextPageToken` | string | No | Token para paginación para obtener la siguiente página de resultados |
|
||||
| `trash` | boolean | No | Establecer como true para listar grabaciones de la papelera |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `recordings` | array | Lista de grabaciones |
|
||||
| `pageInfo` | object | Información de paginación |
|
||||
|
||||
### `zoom_get_meeting_recordings`
|
||||
|
||||
Obtener todas las grabaciones de una reunión específica de Zoom
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Sí | El ID de la reunión o UUID de la reunión |
|
||||
| `includeFolderItems` | boolean | No | Incluir elementos dentro de una carpeta |
|
||||
| `ttl` | number | No | Tiempo de vida para las URLs de descarga en segundos \(máx. 604800\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `recording` | object | La grabación de la reunión con todos los archivos |
|
||||
|
||||
### `zoom_delete_recording`
|
||||
|
||||
Eliminar grabaciones en la nube de una reunión de Zoom
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Sí | El ID de la reunión o UUID de la reunión |
|
||||
| `recordingId` | string | No | ID específico del archivo de grabación a eliminar. Si no se proporciona, elimina todas las grabaciones. |
|
||||
| `action` | string | No | Acción de eliminación: "trash" \(mover a la papelera\) o "delete" \(eliminar permanentemente\) |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Si la grabación se eliminó correctamente |
|
||||
|
||||
### `zoom_list_past_participants`
|
||||
|
||||
Listar participantes de una reunión pasada de Zoom
|
||||
|
||||
#### Entrada
|
||||
|
||||
| Parámetro | Tipo | Obligatorio | Descripción |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `meetingId` | string | Sí | El ID o UUID de la reunión pasada |
|
||||
| `pageSize` | number | No | Número de registros por página \(máx. 300\) |
|
||||
| `nextPageToken` | string | No | Token para paginación para obtener la siguiente página de resultados |
|
||||
|
||||
#### Salida
|
||||
|
||||
| Parámetro | Tipo | Descripción |
|
||||
| --------- | ---- | ----------- |
|
||||
| `participants` | array | Lista de participantes de la reunión |
|
||||
| `pageInfo` | object | Información de paginación |
|
||||
|
||||
## Notas
|
||||
|
||||
- Categoría: `tools`
|
||||
- Tipo: `zoom`
|
||||
@@ -66,16 +66,16 @@ Para hacer referencia a variables de entorno en tus flujos de trabajo, utiliza l
|
||||
height={350}
|
||||
/>
|
||||
|
||||
## Precedencia de variables
|
||||
## Cómo se resuelven las variables
|
||||
|
||||
Cuando tienes variables personales y de espacio de trabajo con el mismo nombre:
|
||||
**Las variables del espacio de trabajo siempre tienen prioridad** sobre las variables personales, independientemente de quién ejecute el flujo de trabajo.
|
||||
|
||||
1. **Las variables del espacio de trabajo tienen precedencia** sobre las variables personales
|
||||
2. Esto previene conflictos de nombres y asegura un comportamiento consistente en los flujos de trabajo del equipo
|
||||
3. Si existe una variable de espacio de trabajo, la variable personal con el mismo nombre será ignorada
|
||||
Cuando no existe una variable de espacio de trabajo para una clave, se utilizan las variables personales:
|
||||
- **Ejecuciones manuales (UI)**: Tus variables personales
|
||||
- **Ejecuciones automatizadas (API, webhook, programación, chat implementado)**: Variables personales del propietario del flujo de trabajo
|
||||
|
||||
<Callout type="warning">
|
||||
Elige los nombres de las variables cuidadosamente para evitar sobrescrituras no deseadas. Considera usar prefijos con tus iniciales para variables personales o con el nombre del proyecto para variables del espacio de trabajo.
|
||||
<Callout type="info">
|
||||
Las variables personales son mejores para pruebas. Usa variables de espacio de trabajo para flujos de trabajo de producción.
|
||||
</Callout>
|
||||
|
||||
## Mejores prácticas de seguridad
|
||||
|
||||
@@ -251,32 +251,78 @@ Récupérer les détails d'exécution, y compris l'instantané de l'état du wor
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Abonnements aux webhooks
|
||||
## Notifications
|
||||
|
||||
Recevez des notifications en temps réel lorsque les exécutions de workflow sont terminées. Les webhooks sont configurés via l'interface utilisateur Sim dans l'éditeur de workflow.
|
||||
Recevez des notifications en temps réel lorsque les exécutions de flux de travail sont terminées via webhook, e-mail ou Slack. Les notifications sont configurées au niveau de l'espace de travail depuis la page Logs.
|
||||
|
||||
### Configuration
|
||||
|
||||
Les webhooks peuvent être configurés pour chaque workflow via l'interface utilisateur de l'éditeur de workflow. Cliquez sur l'icône webhook dans la barre de contrôle pour configurer vos abonnements aux webhooks.
|
||||
Configurez les notifications depuis la page Logs en cliquant sur le bouton menu et en sélectionnant "Configurer les notifications".
|
||||
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<Video src="configure-webhook.mp4" width={700} height={450} />
|
||||
</div>
|
||||
**Canaux de notification :**
|
||||
- **Webhook** : envoi de requêtes HTTP POST à votre point de terminaison
|
||||
- **E-mail** : réception de notifications par e-mail avec les détails d'exécution
|
||||
- **Slack** : publication de messages dans un canal Slack
|
||||
|
||||
**Options de configuration disponibles :**
|
||||
- `url` : URL de votre endpoint webhook
|
||||
- `secret` : Secret optionnel pour la vérification de signature HMAC
|
||||
- `includeFinalOutput` : Inclure la sortie finale du workflow dans la charge utile
|
||||
- `includeTraceSpans` : Inclure les intervalles de trace d'exécution détaillés
|
||||
- `includeRateLimits` : Inclure les informations de limite de débit du propriétaire du workflow
|
||||
- `includeUsageData` : Inclure les données d'utilisation et de facturation du propriétaire du workflow
|
||||
- `levelFilter` : Tableau des niveaux de journal à recevoir (`info`, `error`)
|
||||
- `triggerFilter` : Tableau des types de déclencheurs à recevoir (`api`, `webhook`, `schedule`, `manual`, `chat`)
|
||||
- `active` : Activer/désactiver l'abonnement webhook
|
||||
**Sélection de flux de travail :**
|
||||
- Sélectionnez des flux de travail spécifiques à surveiller
|
||||
- Ou choisissez "Tous les flux de travail" pour inclure les flux actuels et futurs
|
||||
|
||||
### Charge utile du webhook
|
||||
**Options de filtrage :**
|
||||
- `levelFilter` : niveaux de journalisation à recevoir (`info`, `error`)
|
||||
- `triggerFilter` : types de déclencheurs à recevoir (`api`, `webhook`, `schedule`, `manual`, `chat`)
|
||||
|
||||
Lorsqu'une exécution de workflow est terminée, Sim envoie une requête POST à votre URL webhook :
|
||||
**Données optionnelles :**
|
||||
- `includeFinalOutput` : inclure le résultat final du flux de travail
|
||||
- `includeTraceSpans` : inclure les traces détaillées d'exécution
|
||||
- `includeRateLimits` : inclure les informations de limite de débit (limites synchrones/asynchrones et restantes)
|
||||
- `includeUsageData` : inclure l'utilisation et les limites de la période de facturation
|
||||
|
||||
### Règles d'alerte
|
||||
|
||||
Au lieu de recevoir des notifications pour chaque exécution, configurez des règles d'alerte pour être notifié uniquement lorsque des problèmes sont détectés :
|
||||
|
||||
**Échecs consécutifs**
|
||||
- Alerte après X exécutions échouées consécutives (par exemple, 3 échecs d'affilée)
|
||||
- Réinitialisation lorsqu'une exécution réussit
|
||||
|
||||
**Taux d'échec**
|
||||
- Alerte lorsque le taux d'échec dépasse X % au cours des Y dernières heures
|
||||
- Nécessite un minimum de 5 exécutions dans la fenêtre
|
||||
- Ne se déclenche qu'après l'écoulement complet de la fenêtre temporelle
|
||||
|
||||
**Seuil de latence**
|
||||
- Alerte lorsqu'une exécution prend plus de X secondes
|
||||
- Utile pour détecter les flux de travail lents ou bloqués
|
||||
|
||||
**Pic de latence**
|
||||
- Alerte lorsque l'exécution est X % plus lente que la moyenne
|
||||
- Compare à la durée moyenne sur la fenêtre temporelle configurée
|
||||
- Nécessite un minimum de 5 exécutions pour établir une référence
|
||||
|
||||
**Seuil de coût**
|
||||
- Alerte lorsqu'une seule exécution coûte plus de X €
|
||||
- Utile pour détecter les appels LLM coûteux
|
||||
|
||||
**Aucune activité**
|
||||
- Alerte lorsqu'aucune exécution ne se produit pendant X heures
|
||||
- Utile pour surveiller les workflows programmés qui devraient s'exécuter régulièrement
|
||||
|
||||
**Nombre d'erreurs**
|
||||
- Alerte lorsque le nombre d'erreurs dépasse X dans une fenêtre temporelle
|
||||
- Suit le total des erreurs, pas les erreurs consécutives
|
||||
|
||||
Tous les types d'alertes incluent un temps de récupération d'une heure pour éviter le spam de notifications.
|
||||
|
||||
### Configuration du webhook
|
||||
|
||||
Pour les webhooks, des options supplémentaires sont disponibles :
|
||||
- `url` : l'URL de votre point de terminaison webhook
|
||||
- `secret` : secret optionnel pour la vérification de signature HMAC
|
||||
|
||||
### Structure de la charge utile
|
||||
|
||||
Lorsqu'une exécution de workflow se termine, Sim envoie la charge utile suivante (via webhook POST, e-mail ou Slack) :
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -325,15 +371,15 @@ Lorsqu'une exécution de workflow est terminée, Sim envoie une requête POST à
|
||||
}
|
||||
```
|
||||
|
||||
### En-têtes de webhook
|
||||
### En-têtes webhook
|
||||
|
||||
Chaque requête webhook inclut ces en-têtes :
|
||||
Chaque requête webhook inclut ces en-têtes (canal webhook uniquement) :
|
||||
|
||||
- `sim-event` : Type d'événement (toujours `workflow.execution.completed`)
|
||||
- `sim-timestamp` : Horodatage Unix en millisecondes
|
||||
- `sim-event` : type d'événement (toujours `workflow.execution.completed`)
|
||||
- `sim-timestamp` : horodatage Unix en millisecondes
|
||||
- `sim-delivery-id` : ID de livraison unique pour l'idempotence
|
||||
- `sim-signature` : Signature HMAC-SHA256 pour vérification (si un secret est configuré)
|
||||
- `Idempotency-Key` : Identique à l'ID de livraison pour la détection des doublons
|
||||
- `sim-signature` : signature HMAC-SHA256 pour vérification (si un secret est configuré)
|
||||
- `Idempotency-Key` : identique à l'ID de livraison pour la détection des doublons
|
||||
|
||||
### Vérification de signature
|
||||
|
||||
@@ -408,14 +454,14 @@ Si vous configurez un secret webhook, vérifiez la signature pour vous assurer q
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
### Politique de réessai
|
||||
### Politique de nouvelle tentative
|
||||
|
||||
Les livraisons de webhook échouées sont réessayées avec un backoff exponentiel et du jitter :
|
||||
|
||||
- Nombre maximum de tentatives : 5
|
||||
- Délais de réessai : 5 secondes, 15 secondes, 1 minute, 3 minutes, 10 minutes
|
||||
- Délais de nouvelle tentative : 5 secondes, 15 secondes, 1 minute, 3 minutes, 10 minutes
|
||||
- Jitter : jusqu'à 10 % de délai supplémentaire pour éviter l'effet de horde
|
||||
- Seules les réponses HTTP 5xx et 429 déclenchent des réessais
|
||||
- Seules les réponses HTTP 5xx et 429 déclenchent de nouvelles tentatives
|
||||
- Les livraisons expirent après 30 secondes
|
||||
|
||||
<Callout type="info">
|
||||
@@ -424,15 +470,15 @@ Les livraisons de webhook échouées sont réessayées avec un backoff exponenti
|
||||
|
||||
## Bonnes pratiques
|
||||
|
||||
1. **Stratégie de polling** : lors de l'interrogation des logs, utilisez la pagination basée sur curseur avec `order=asc` et `startDate` pour récupérer efficacement les nouveaux logs.
|
||||
1. **Stratégie de polling** : Lors du polling des logs, utilisez la pagination basée sur curseur avec `order=asc` et `startDate` pour récupérer efficacement les nouveaux logs.
|
||||
|
||||
2. **Sécurité des webhooks** : configurez toujours un secret webhook et vérifiez les signatures pour vous assurer que les requêtes proviennent de Sim.
|
||||
2. **Sécurité des webhooks** : Configurez toujours un secret de webhook et vérifiez les signatures pour vous assurer que les requêtes proviennent de Sim.
|
||||
|
||||
3. **Idempotence** : utilisez l'en-tête `Idempotency-Key` pour détecter et gérer les livraisons de webhook en double.
|
||||
3. **Idempotence** : Utilisez l'en-tête `Idempotency-Key` pour détecter et gérer les livraisons de webhook en double.
|
||||
|
||||
4. **Confidentialité** : par défaut, `finalOutput` et `traceSpans` sont exclus des réponses. Activez-les uniquement si vous avez besoin des données et comprenez les implications en matière de confidentialité.
|
||||
4. **Confidentialité** : Par défaut, `finalOutput` et `traceSpans` sont exclus des réponses. Activez-les uniquement si vous avez besoin des données et comprenez les implications en matière de confidentialité.
|
||||
|
||||
5. **Limitation de débit** : implémentez un backoff exponentiel lorsque vous recevez des réponses 429. Vérifiez l'en-tête `Retry-After` pour connaître le temps d'attente recommandé.
|
||||
5. **Limitation de débit** : Implémentez un backoff exponentiel lorsque vous recevez des réponses 429. Vérifiez l'en-tête `Retry-After` pour connaître le temps d'attente recommandé.
|
||||
|
||||
## Limitation de débit
|
||||
|
||||
@@ -443,12 +489,12 @@ L'API implémente une limitation de débit pour garantir une utilisation équita
|
||||
- **Plan Équipe** : 60 requêtes par minute
|
||||
- **Plan Entreprise** : Limites personnalisées
|
||||
|
||||
Les informations de limite de débit sont incluses dans les en-têtes de réponse :
|
||||
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
|
||||
|
||||
## Exemple : Interrogation pour nouveaux journaux
|
||||
## Exemple : Polling pour nouveaux logs
|
||||
|
||||
```javascript
|
||||
let cursor = null;
|
||||
|
||||
@@ -147,4 +147,4 @@ L'instantané fournit :
|
||||
|
||||
- Découvrez le [Calcul des coûts](/execution/costs) pour comprendre la tarification des workflows
|
||||
- Explorez l'[API externe](/execution/api) pour un accès programmatique aux journaux
|
||||
- Configurez les [notifications Webhook](/execution/api#webhook-subscriptions) pour des alertes en temps réel
|
||||
- Configurez les [Notifications](/execution/api#notifications) pour des alertes en temps réel par webhook, e-mail ou Slack
|
||||
199
apps/docs/content/docs/fr/tools/ahrefs.mdx
Normal file
199
apps/docs/content/docs/fr/tools/ahrefs.mdx
Normal file
@@ -0,0 +1,199 @@
|
||||
---
|
||||
title: Ahrefs
|
||||
description: Analyse SEO avec Ahrefs
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="ahrefs"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Ahrefs](https://ahrefs.com/) est un ensemble d'outils SEO de premier plan pour analyser les sites web, suivre les classements, surveiller les backlinks et rechercher des mots-clés. Il fournit des informations détaillées sur votre propre site web ainsi que sur ceux de vos concurrents, vous aidant à prendre des décisions basées sur les données pour améliorer votre visibilité dans les moteurs de recherche.
|
||||
|
||||
Avec l'intégration d'Ahrefs dans Sim, vous pouvez :
|
||||
|
||||
- **Analyser le Domain Rating et l'autorité** : vérifier instantanément le Domain Rating (DR) et le rang Ahrefs de n'importe quel site web pour évaluer son autorité.
|
||||
- **Récupérer les backlinks** : obtenir une liste des backlinks pointant vers un site ou une URL spécifique, avec des détails comme le texte d'ancrage, le DR de la page référente, et plus encore.
|
||||
- **Obtenir des statistiques sur les backlinks** : accéder aux métriques sur les types de backlinks (dofollow, nofollow, texte, image, redirection, etc.) pour un domaine ou une URL.
|
||||
- **Explorer les mots-clés organiques** *(prévu)* : voir les mots-clés pour lesquels un domaine est classé et leurs positions dans les résultats de recherche Google.
|
||||
- **Découvrir les meilleures pages** *(prévu)* : identifier les pages les plus performantes par trafic organique et liens.
|
||||
|
||||
Ces outils permettent à vos agents d'automatiser la recherche SEO, de surveiller les concurrents et de générer des rapports, le tout dans le cadre de vos automatisations de flux de travail. Pour utiliser l'intégration Ahrefs, vous aurez besoin d'un abonnement Ahrefs Enterprise avec accès API.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instructions d'utilisation
|
||||
|
||||
Intégrez les outils SEO d'Ahrefs dans votre flux de travail. Analysez les évaluations de domaine, les backlinks, les mots-clés organiques, les meilleures pages et plus encore. Nécessite un plan Ahrefs Enterprise avec accès API.
|
||||
|
||||
## Outils
|
||||
|
||||
### `ahrefs_domain_rating`
|
||||
|
||||
Obtenez le Domain Rating (DR) et le rang Ahrefs pour un domaine cible. Le Domain Rating montre la force d'un site web
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | chaîne | Oui | Le domaine cible à analyser \(par ex., example.com\) |
|
||||
| `date` | chaîne | Non | Date pour les données historiques au format AAAA-MM-JJ \(par défaut : aujourd'hui\) |
|
||||
| `apiKey` | chaîne | Oui | Clé API Ahrefs |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `domainRating` | nombre | Score de Domain Rating \(0-100\) |
|
||||
| `ahrefsRank` | nombre | Ahrefs Rank - classement mondial basé sur la force du profil de backlinks |
|
||||
|
||||
### `ahrefs_backlinks`
|
||||
|
||||
Obtenir une liste de backlinks pointant vers un domaine ou une URL cible. Renvoie des détails sur chaque backlink, y compris l'URL source, le texte d'ancrage et le domain rating.
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | chaîne | Oui | Le domaine ou l'URL cible à analyser |
|
||||
| `mode` | chaîne | Non | Mode d'analyse : domain \(domaine entier\), prefix \(préfixe d'URL\), subdomains \(inclure tous les sous-domaines\), exact \(correspondance exacte d'URL\) |
|
||||
| `date` | chaîne | Non | Date pour les données historiques au format AAAA-MM-JJ \(par défaut : aujourd'hui\) |
|
||||
| `limit` | nombre | Non | Nombre maximum de résultats à renvoyer \(par défaut : 100\) |
|
||||
| `offset` | nombre | Non | Nombre de résultats à ignorer pour la pagination |
|
||||
| `apiKey` | chaîne | Oui | Clé API Ahrefs |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `backlinks` | array | Liste des backlinks pointant vers la cible |
|
||||
|
||||
### `ahrefs_backlinks_stats`
|
||||
|
||||
Obtenez des statistiques de backlinks pour un domaine ou une URL cible. Renvoie les totaux pour différents types de backlinks, y compris les liens dofollow, nofollow, texte, image et de redirection.
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Oui | Le domaine ou l'URL cible à analyser |
|
||||
| `mode` | string | Non | Mode d'analyse : domain \(domaine entier\), prefix \(préfixe d'URL\), subdomains \(inclure tous les sous-domaines\), exact \(correspondance exacte d'URL\) |
|
||||
| `date` | string | Non | Date pour les données historiques au format AAAA-MM-JJ \(par défaut : aujourd'hui\) |
|
||||
| `apiKey` | string | Oui | Clé API Ahrefs |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `stats` | object | Résumé des statistiques de backlinks |
|
||||
|
||||
### `ahrefs_referring_domains`
|
||||
|
||||
Obtenez une liste des domaines qui renvoient vers un domaine ou une URL cible. Renvoie des domaines référents uniques avec leur notation de domaine, le nombre de backlinks et les dates de découverte.
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Oui | Le domaine ou l'URL cible à analyser |
|
||||
| `mode` | string | Non | Mode d'analyse : domain \(domaine entier\), prefix \(préfixe d'URL\), subdomains \(inclure tous les sous-domaines\), exact \(correspondance exacte d'URL\) |
|
||||
| `date` | string | Non | Date pour les données historiques au format AAAA-MM-JJ \(par défaut : aujourd'hui\) |
|
||||
| `limit` | number | Non | Nombre maximum de résultats à renvoyer \(par défaut : 100\) |
|
||||
| `offset` | number | Non | Nombre de résultats à ignorer pour la pagination |
|
||||
| `apiKey` | string | Oui | Clé API Ahrefs |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `referringDomains` | array | Liste des domaines pointant vers la cible |
|
||||
|
||||
### `ahrefs_organic_keywords`
|
||||
|
||||
Obtenez les mots-clés organiques pour lesquels un domaine ou une URL cible est classé dans les résultats de recherche Google. Renvoie les détails des mots-clés, y compris le volume de recherche, la position de classement et le trafic estimé.
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `target` | string | Oui | Le domaine ou l'URL cible à analyser |
|
||||
| `country` | string | Non | Code pays pour les résultats de recherche \(ex. : us, gb, de\). Par défaut : us |
|
||||
| `mode` | string | Non | Mode d'analyse : domain \(domaine entier\), prefix \(préfixe d'URL\), subdomains \(inclure tous les sous-domaines\), exact \(correspondance exacte d'URL\) |
|
||||
| `date` | string | Non | Date pour les données historiques au format AAAA-MM-JJ \(par défaut : aujourd'hui\) |
|
||||
| `limit` | number | Non | Nombre maximum de résultats à renvoyer \(par défaut : 100\) |
|
||||
| `offset` | number | Non | Nombre de résultats à ignorer pour la pagination |
|
||||
| `apiKey` | string | Oui | Clé API Ahrefs |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `keywords` | array | Liste des mots-clés organiques pour lesquels la cible est classée |
|
||||
|
||||
### `ahrefs_top_pages`
|
||||
|
||||
Obtenez les meilleures pages d'un domaine cible triées par trafic organique. Renvoie les URL des pages avec leur trafic, le nombre de mots-clés et la valeur estimée du trafic.
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `target` | string | Oui | Le domaine cible à analyser |
|
||||
| `country` | string | Non | Code pays pour les données de trafic \(ex., us, gb, de\). Par défaut : us |
|
||||
| `mode` | string | Non | Mode d'analyse : domain \(domaine entier\), prefix \(préfixe d'URL\), subdomains \(inclure tous les sous-domaines\) |
|
||||
| `date` | string | Non | Date pour les données historiques au format AAAA-MM-JJ \(par défaut : aujourd'hui\) |
|
||||
| `limit` | number | Non | Nombre maximum de résultats à retourner \(par défaut : 100\) |
|
||||
| `offset` | number | Non | Nombre de résultats à ignorer pour la pagination |
|
||||
| `apiKey` | string | Oui | Clé API Ahrefs |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `pages` | array | Liste des meilleures pages par trafic organique |
|
||||
|
||||
### `ahrefs_keyword_overview`
|
||||
|
||||
Obtenez des métriques détaillées pour un mot-clé, y compris le volume de recherche, la difficulté du mot-clé, le CPC, les clics et le potentiel de trafic.
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | ---------- | ----------- |
|
||||
| `keyword` | string | Oui | Le mot-clé à analyser |
|
||||
| `country` | string | Non | Code pays pour les données de mot-clé \(ex., us, gb, de\). Par défaut : us |
|
||||
| `apiKey` | string | Oui | Clé API Ahrefs |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `overview` | object | Aperçu des métriques du mot-clé |
|
||||
|
||||
### `ahrefs_broken_backlinks`
|
||||
|
||||
Obtenez une liste de backlinks brisés pointant vers un domaine ou une URL cible. Utile pour identifier les opportunités de récupération de liens.
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | ----------- | ----------- |
|
||||
| `target` | chaîne | Oui | Le domaine ou l'URL cible à analyser |
|
||||
| `mode` | chaîne | Non | Mode d'analyse : domain \(domaine entier\), prefix \(préfixe d'URL\), subdomains \(inclure tous les sous-domaines\), exact \(correspondance exacte d'URL\) |
|
||||
| `date` | chaîne | Non | Date pour les données historiques au format AAAA-MM-JJ \(par défaut : aujourd'hui\) |
|
||||
| `limit` | nombre | Non | Nombre maximum de résultats à retourner \(par défaut : 100\) |
|
||||
| `offset` | nombre | Non | Nombre de résultats à ignorer pour la pagination |
|
||||
| `apiKey` | chaîne | Oui | Clé API Ahrefs |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `brokenBacklinks` | tableau | Liste des backlinks brisés |
|
||||
|
||||
## Remarques
|
||||
|
||||
- Catégorie : `tools`
|
||||
- Type : `ahrefs`
|
||||
89
apps/docs/content/docs/fr/tools/apify.mdx
Normal file
89
apps/docs/content/docs/fr/tools/apify.mdx
Normal file
@@ -0,0 +1,89 @@
|
||||
---
|
||||
title: Apify
|
||||
description: Exécutez des acteurs Apify et récupérez les résultats
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="apify"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[Apify](https://apify.com/) est une plateforme puissante pour créer, déployer et exécuter des automatisations web et des acteurs de scraping à grande échelle. Apify vous permet d'extraire des données utiles de n'importe quel site web, d'automatiser des flux de travail et de connecter vos pipelines de données de manière transparente.
|
||||
|
||||
Avec Apify, vous pouvez :
|
||||
|
||||
- **Exécuter des acteurs prêts à l'emploi ou personnalisés** : Intégrez des acteurs publics ou développez les vôtres, en automatisant un large éventail d'extractions de données web et de tâches de navigation.
|
||||
- **Récupérer des ensembles de données** : Accédez et gérez des ensembles de données structurées collectées par les acteurs en temps réel.
|
||||
- **Mettre à l'échelle l'automatisation web** : Exploitez l'infrastructure cloud pour exécuter des tâches de manière fiable, de façon asynchrone ou synchrone, avec une gestion robuste des erreurs.
|
||||
|
||||
Dans Sim, l'intégration Apify permet à vos agents d'effectuer des opérations Apify essentielles de manière programmatique :
|
||||
|
||||
- **Exécuter un acteur (Sync)** : Utilisez `apify_run_actor_sync` pour lancer un acteur Apify et attendre sa complétion, récupérant les résultats dès que l'exécution se termine.
|
||||
- **Exécuter un acteur (Async)** : Utilisez `apify_run_actor_async` pour démarrer un acteur en arrière-plan et interroger périodiquement les résultats, adapté aux tâches plus longues ou complexes.
|
||||
|
||||
Ces opérations équipent vos agents pour automatiser, scraper et orchestrer la collecte de données ou les tâches d'automatisation de navigateur directement dans les flux de travail — le tout avec une configuration flexible et une gestion des résultats, sans nécessiter d'exécutions manuelles ou d'outils externes. Intégrez Apify comme un moteur dynamique d'automatisation et d'extraction de données qui alimente de manière programmatique les flux de travail à l'échelle du web de vos agents.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
## Instructions d'utilisation
|
||||
|
||||
Intégrez Apify dans votre flux de travail. Exécutez n'importe quel acteur Apify avec des entrées personnalisées et récupérez les résultats. Prend en charge l'exécution synchrone et asynchrone avec récupération automatique des ensembles de données.
|
||||
|
||||
## Outils
|
||||
|
||||
### `apify_run_actor_sync`
|
||||
|
||||
Exécuter un acteur APIFY de manière synchrone et obtenir les résultats (maximum 5 minutes)
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | chaîne | Oui | Jeton API APIFY depuis console.apify.com/account#/integrations |
|
||||
| `actorId` | chaîne | Oui | ID de l'acteur ou nom d'utilisateur/nom-acteur \(ex. : "janedoe/my-actor" ou ID de l'acteur\) |
|
||||
| `input` | chaîne | Non | Entrée de l'acteur sous forme de chaîne JSON. Voir la documentation de l'acteur pour les champs requis. |
|
||||
| `timeout` | nombre | Non | Délai d'attente en secondes \(par défaut : valeur par défaut de l'acteur\) |
|
||||
| `build` | chaîne | Non | Version de l'acteur à exécuter \(ex. : "latest", "beta", ou tag/numéro de build\) |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | booléen | Indique si l'exécution de l'acteur a réussi |
|
||||
| `runId` | chaîne | ID d'exécution APIFY |
|
||||
| `status` | chaîne | Statut d'exécution \(SUCCEEDED, FAILED, etc.\) |
|
||||
| `datasetId` | chaîne | ID du jeu de données contenant les résultats |
|
||||
| `items` | tableau | Éléments du jeu de données \(si terminé\) |
|
||||
|
||||
### `apify_run_actor_async`
|
||||
|
||||
Exécuter un acteur APIFY de manière asynchrone avec interrogation périodique pour les tâches de longue durée
|
||||
|
||||
#### Entrée
|
||||
|
||||
| Paramètre | Type | Obligatoire | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `apiKey` | chaîne | Oui | Jeton API APIFY depuis console.apify.com/account#/integrations |
|
||||
| `actorId` | chaîne | Oui | ID de l'acteur ou nom d'utilisateur/nom-acteur \(ex. : "janedoe/my-actor" ou ID de l'acteur\) |
|
||||
| `input` | chaîne | Non | Entrée de l'acteur sous forme de chaîne JSON |
|
||||
| `waitForFinish` | nombre | Non | Temps d'attente initial en secondes \(0-60\) avant le début de l'interrogation |
|
||||
| `itemLimit` | nombre | Non | Nombre maximum d'éléments de jeu de données à récupérer \(1-250000, par défaut 100\) |
|
||||
| `timeout` | nombre | Non | Délai d'attente en secondes \(par défaut : valeur par défaut de l'acteur\) |
|
||||
| `build` | chaîne | Non | Version de l'acteur à exécuter \(ex. : "latest", "beta", ou tag/numéro de build\) |
|
||||
|
||||
#### Sortie
|
||||
|
||||
| Paramètre | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Indique si l'exécution de l'acteur a réussi |
|
||||
| `runId` | string | ID d'exécution APIFY |
|
||||
| `status` | string | Statut d'exécution \(SUCCEEDED, FAILED, etc.\) |
|
||||
| `datasetId` | string | ID du dataset contenant les résultats |
|
||||
| `items` | array | Éléments du dataset \(si terminé\) |
|
||||
|
||||
## Notes
|
||||
|
||||
- Catégorie : `tools`
|
||||
- Type : `apify`
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user