GEO Writer

Erstellen und verwalten Sie KI-gestützte Aufgaben im GEO Writer. Aufgaben werden asynchron verarbeitet: Erstellen Sie eine Aufgabe und fragen Sie sie anschließend regelmäßig ab, bis sie abgeschlossen ist.

POST/intelligence_tasks

Erstellt eine Aufgabe im GEO Writer. Es gibt zwei Modi: promptbasiert (mit prompt_id) oder agentisch (mit custom_topic und/oder user_instructions). Der Typ product_listing erwartet stattdessen ein product-Objekt und liefert Texte für die Produktseite, die sich direkt übernehmen lassen.

Anfragetext (JSON):
  • project_iderforderlich
  • task_typeerforderlich: brief, create, update, pr_insights, custom, product_listing
  • prompt_id
  • custom_topic
  • user_instructions
  • output_language_code
  • existing_content
  • existing_content_url

Nur für product_listing: product (erforderlich: title, dazu external_id, description_html, seo_title, seo_description, url, product_type und bis zu 20 images mit id und alt) und prompt_ids (bis zu 20 Prompts des Projekts, auf die die Texte ausgerichtet werden). Das result_data einer abgeschlossenen Aufgabe dieses Typs enthält summary, description_html, faq, seo_title, seo_description, image_alts und changes.

GET/intelligence_tasks

Listet die Aufgaben im GEO Writer für ein Projekt auf, optional gefiltert.

Parameter:
  • project_iderforderlich
  • task_type
  • statuspending|processing|review|completed|in_progress|blocked|discarded
  • page
  • per_page

Verworfene Aufgaben werden nie aufgelistet, daher liefert status=discarded eine leere Seite.

GET/intelligence_tasks/:id

Liefert alle Details einer Aufgabe, nach Abschluss einschließlich der Ergebnisdaten. Akzeptiert die numerische ID oder die public_id.

Parameter:
  • project_iderforderlich
  • :idAufgaben-ID oder public_id in der URL

PATCH/intelligence_tasks/:id

Bearbeitet vorhandene Textblöcke einer abgeschlossenen Aufgabe, ohne die Aufgabe neu zu generieren. Jeder Schlüssel in edits ist ein Pfad in Punktnotation zu einem Textwert in result_data (zum Beispiel sections.0.content), und nur vorhandener Text kann geändert werden. Ein Wert, der dem gespeicherten Text entspricht, wird ignoriert. Bei der ersten Änderung wird die KI-Version gesichert, damit sie wiederhergestellt werden kann.

Anfragetext (JSON):
  • project_iderforderlich
  • :idAufgaben-ID oder public_id in der URL
  • editserforderlich, Objekt, das jedem Pfad in Punktnotation den neuen Text zuordnet

Erfordert einen API-Schlüssel mit Schreibzugriff.

result_version (optional): Senden Sie den Wert von result_version, den Sie beim Abrufen der Aufgabe erhalten haben. Wurde die Aufgabe seitdem neu generiert, wird die Änderung mit ERR_STALE_CONTENT (HTTP 409) abgelehnt und nichts gespeichert: Rufen Sie die Aufgabe erneut ab und senden Sie Ihre Änderungen noch einmal. Ohne diesen Parameter werden die Änderungen auf den aktuellen Stand der Aufgabe angewendet.

POST/intelligence_tasks/:id/revert

Verwirft alle manuellen Änderungen und stellt die KI-Version wieder her, die bei der ersten Änderung gesichert wurde. Gibt ERR_INVALID_PARAM zurück, wenn die Aufgabe keine manuellen Änderungen enthält.

Parameter:
  • project_iderforderlich
  • :idAufgaben-ID oder public_id in der URL

Erfordert einen API-Schlüssel mit Schreibzugriff.