Synup
Schlüssel erstellen
v1Ressourcen/AEO/patchVerfolgten Prompt bearbeiten, pausieren oder fortsetzen

Verfolgten Prompt bearbeiten, pausieren oder fortsetzen

Ändert den Wortlaut eines Prompts, seinen Status oder beides: Senden Sie text, status oder beides, zusammen mit expectedWordingVersion, expectedRevision und mutationId. Fehlen beide, liefert das 400 invalid_input. Eine Änderung des Wortlauts behält den bisherigen Wortlaut und seine Ergebnisse, und der neue Wortlaut wird ab der nächsten Prüfung als neue Ausgangsbasis gemessen. Pausieren nimmt den Prompt aus künftigen Prüfungen heraus, ohne ihn zu entfernen; Fortsetzen zählt ihn wieder zu den 16 aktiven Prompts (409 prompt_limit, wenn das überschritten würde). Eine Anfrage, die dem gespeicherten Stand entspricht, speichert nichts und antwortet mit noop true. Wie jeder Schreibvorgang startet oder kauft sie nie eine Prüfung, lässt den Zeitplan unverändert und verbraucht keine Credits, und sie erfordert die Berechtigung Manage AEO prompts sowie eingeschaltete Prompt-Verwaltung. Ein unbekannter oder entfernter Prompt liefert 404 prompt_not_found.

patch/api/v1/aeo/prompts/{promptId}
aeo:write
Query-Parameter
promptIdstringerforderlich
Die ID des verfolgten Prompts.
locationIdstringoptional
Die Standort-ID der Website-Entität, als Query-Parameter oder im Body. Werden beide gesendet, gilt der Query-Parameter.
Anfragetext
locationIdstringoptional
Die Standort-ID der Website-Entität, als Query-Parameter oder im Body. Werden beide gesendet, gilt der Query-Parameter.
textstringoptional
Neuer Wortlaut für den Prompt, bis zu 500 Zeichen. Eine echte Änderung erzeugt eine neue Wortlautversion: Der bisherige Wortlaut und seine Ergebnisse bleiben erhalten, und der neue Wortlaut wird ab der nächsten Prüfung als neue Ausgangsbasis gemessen. Den aktuellen Wortlaut zu senden, ändert nichts.
statusstring (active | paused)optional
Als Listenfilter: all (Standard), active oder paused; jeder andere Wert listet alle. Bei einer Aktualisierung: active, um den Prompt fortzusetzen, paused, um ihn zu pausieren. Ein pausierter Prompt bleibt im Set, wird aber nicht geprüft.
expectedWordingVersionintegererforderlich
Die zuletzt gelesene wordingVersion des Prompts. Hat sich der Wortlaut seitdem geändert, liefert die Aktualisierung 409 prompt_version_changed mit der aktuellen wordingVersion.
expectedRevisionintegererforderlich
Die zuletzt gelesene Set-Revision (revision in der Listenansicht). Die Änderung wird nur angewendet, wenn sie noch übereinstimmt; sonst liefert sie 409 prompt_set_changed mit latestRevision, damit Sie das Set neu lesen und entscheiden können.
mutationIdstringerforderlich
Ihre ID für diese Änderung: 8 bis 100 Buchstaben, Ziffern, _ oder -. Bei DELETE senden Sie sie als Header Idempotency-Key. Ist unter einer ID eine Änderung gespeichert, liefert dieselbe Anfrage erneut replayed true und die aktuelle Ansicht, ohne die Änderung noch einmal anzuwenden; dieselbe ID für eine andere Anfrage liefert 409 mutation_reused. Eine Anfrage, die nichts geändert hat, speichert keine ID: Ihre Wiederholung wird gegen die aktuelle Revision neu entschieden (noop true oder 409 prompt_set_changed, wenn sich das Set inzwischen geändert hat). Wenn unklar ist, ob ein Schreibvorgang angekommen ist, wiederholen Sie ihn mit derselben ID oder lesen Sie die Liste und gleichen Sie ab, bevor Sie eine neue ID senden.
Antwort
dataobjectoptional
viewobjectoptional
locationIdstringoptional
Die Standort-ID der Website-Entität.
namestringoptional
Der Name der Website.
eligibleboolean (true)optional
Immer true: Nur eine Website-Entität hat eine Liste verfolgter Prompts.
canEditbooleanoptional
Ob die Person, die das Token ausgestellt hat, dieses Set gerade ändern kann: Sie hat die Berechtigung Manage AEO prompts, die Prompt-Verwaltung ist für die Agentur eingeschaltet, und die frühere Prompt-Liste muss nicht abgeglichen werden.
managedbooleanoptional
false, solange die Website noch ihre zwischengespeicherte bestehende Prompt-Liste verwendet (als importierte Prompts unbekannter Herkunft angezeigt); true ab der ersten gespeicherten Änderung.
revisionintegeroptional
Die Revision des Sets, die jede gespeicherte Änderung erhöht. Senden Sie sie als expectedRevision oder bei DELETE in If-Match.
maxActiveintegeroptional
Die maximale Anzahl gleichzeitig aktiver Prompts (16).
maxLengthintegeroptional
Die maximale Länge eines Prompts in Zeichen (500).
countsobjectoptional
Anzahl aktiver und pausierter Prompts.
activeintegeroptional
pausedintegeroptional
itemsarray of objectoptional
Die Prompts in der Reihenfolge des Sets, gefiltert nach dem Parameter status.
idstringoptional
Eindeutige Kennung des Prompts.
textstringoptional
Der Wortlaut des Prompts. In einer Prüfung oder einem Verlaufseintrag der Wortlaut, den diese Prüfung gemessen hat.
normalizedTextstringoptional
Der Wortlaut getrimmt, mit zusammengefassten Leerzeichen und in Kleinbuchstaben: der Schlüssel zur Erkennung von Duplikaten.
wordingVersionintegeroptional
Die Version des Wortlauts: 1 bei der Erstellung, nach jeder Änderung des Wortlauts um eins höher. Senden Sie sie als expectedWordingVersion zurück.
statusstring (active | paused)optional
active (wird von der nächsten Prüfung gemessen) oder paused (bleibt erhalten, wird aber nicht geprüft).
originstring (existing | custom | generated | integration)optional
Herkunft des Prompts: existing (aus der früheren Prompt-Liste der Website importiert, Herkunft unbekannt), custom (in der App hinzugefügt), generated oder integration (über die API oder MCP hinzugefügt).
createdViastring (ui | api | mcp | import)optional
Wie der Prompt erstellt wurde: ui, api, mcp oder import.
createdByUserIdstringoptional
Die Person, die den Prompt erstellt hat, oder null, wenn unbekannt (importierte Prompts).
updatedByUserIdstringoptional
Die Person, die den Prompt zuletzt geändert hat, oder null, wenn unbekannt.
positionintegeroptional
Die Stelle des Prompts in der Reihenfolge des Sets.
createdAtstringoptional
Wann der Prompt erstellt wurde, als ISO-8601-Zeitstempel.
updatedAtstringoptional
Wann der Prompt zuletzt geändert wurde, als ISO-8601-Zeitstempel.
deletedAtstringoptional
Wann der Prompt entfernt wurde, oder null. Entfernte Prompts werden nicht aufgeführt, bleiben aber in den Prüfungen, die sie erfasst haben.
latestobjectoptional
Das neueste verwertbare Ergebnis für den aktuellen Wortlaut, aus einer abgeschlossenen Prüfung mit complete, partial oder failed oder aus einem nachweislich übereinstimmenden importierten Alt-Wortlaut: state checked mit at, measured und expected. Eine Prüfung mit held bleibt im Verlauf und aktualisiert es nicht. Sonst state not_checked, auch direkt nach einer Bearbeitung.
editedbooleanoptional
Ob sich der Wortlaut seit der Erstellung des Prompts geändert hat.
workloadobjectoptional
Ungefähr, was eine Prüfung der aktiven Prompts umfasst. Das Lesen kostet nichts, und das Speichern von Prompts verbraucht keine Credits.
activePromptsintegeroptional
Aktive Prompts, die die nächste Prüfung messen würde.
enginesarray of stringoptional
Die KI-Engines, die eine Prüfung abfragt.
answerChecksintegeroptional
Aktive Prompts × Engines: die Antworten, die eine Prüfung anfordert. Eine Anzahl, keine Credits.
estimatedCreditsnumberoptional
Ungefähre Credits für eine Prüfung der aktiven Prompts, nach den Credit-Sätzen Ihrer Agentur. null, wenn der Satz unbekannt ist oder mehr als 16 Prompts aktiv sind — unbekannt, nicht 0. Eine Schätzung, keine Abbuchung.
creditsPerPromptnumberoptional
Ungefähre Credits pro Prompt über alle Engines, oder null, wenn unbekannt.
approximateboolean (true)optional
Immer true: Die Aufwandswerte sind Schätzungen.
scheduleobjectoptional
Der aktuelle AEO-Prüfzeitplan der Website. Änderungen an Prompts ändern ihn nicht.
frequencystring (weekly | monthly | quarterly | never)optional
Wie oft Prüfungen laufen: weekly, monthly, quarterly oder never.
nextRunAtstringoptional
Wann die nächste geplante Prüfung fällig ist, als ISO-8601-Zeitstempel, oder null, wenn die Häufigkeit never ist oder die Prüfungen für diese Website noch nicht begonnen haben.
activatedbooleanoptional
Ob die Prüfungen für diese Website begonnen haben (eine erste Prüfung wurde gestartet oder es gibt einen Bericht). Das Speichern von Prompts startet sie nicht.
checkInFlightbooleanoptional
Ob gerade eine Prüfung für diese Website eingereiht ist, läuft oder angehalten ist. Diese Prüfung behält die erfassten Prompts; Änderungen gelten ab der nächsten.
listChangedSinceReportbooleanoptional
Ob sich die aktiven Prompts von denen unterscheiden, die der aktuelle Bericht gemessen hat, sodass der Bericht die aktuelle Liste noch nicht widerspiegelt.
needsReconciliationbooleanoptional
Ob die frühere Prompt-Liste der Website fehlerhafte oder doppelte Einträge hat. Bis der Support sie abgleicht, liefern Änderungen 409 legacy_prompts_need_reconciliation.
noopbooleanoptional
true, wenn die Anfrage dem gespeicherten Stand entsprach und nichts gespeichert wurde.
replayedbooleanoptional
true, wenn dies eine bereits unter derselben mutationId gespeicherte Änderung wiederholt; die Änderung wird nicht erneut angewendet, und view ist die aktuelle Ansicht.
createdIdsarray of stringoptional
IDs der Prompts, die diese Anfrage hinzugefügt hat, in Reihenfolge. Leer bei anderen Änderungen und bei einer Wiederholung.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
409Die Anfrage steht im Widerspruch zum aktuellen Zustand der Ressource — zum Beispiel beim Ändern der E-Mail-Adresse oder Telefonnummer eines Empfängers, dem bereits eine Nachricht gesendet wurde, oder bei einer Team-Einladung, die bereits akzeptiert wurde (oder noch nicht akzeptiert wurde).
422Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
503Der Dienst ist vorübergehend nicht verfügbar. Befolgen Sie die Hinweise zur Wiederholung für diesen Vorgang.
patch/api/v1/aeo/prompts/{promptId}
Ihr API-Schlüssel
promptId *
locationId
Anfragetext*
{}

Anleitungen, die diese Ressource verwenden