Ferndesk

Aufgaben

Aufgabe erstellen

Erstellt eine neue Aufgabe und stellt sie zur KI-Verarbeitung in die Warteschlange. Mit Aufgaben können Sie die KI von Ferndesk anweisen, anhand Ihrer Beschreibung Hilfeartikel zu erstellen oder zu aktualisieren.

Erfordert den Scope content:write. Ratenbegrenzung: 10 Anfragen pro Stunde und API-Schlüssel.

Erforderlicher Scope: content:write

POST /tasks

Aufgabe erstellen

curl --request POST \
  --url 'https://api.ferndesk.com/v1/tasks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "title": "<string>",
  "status": "<string>"
}

Erstellte Aufgabe

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel tragen das Präfix fdsk_ und sollten geheim gehalten werden. Sie können Schlüssel auf der Seite Entwicklereinstellungen erstellen und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt führt den erforderlichen Scope über x-required-scopes auf):

    • content:read: Hilfeartikel, Sammlungen, Abschnitte und Übersetzungen lesen und durchsuchen
    • content:write: Artikelentwürfe, Benutzer und Aufgaben erstellen und bearbeiten; Artikel und Sammlungen verschieben
    • content:publish: Inhalte veröffentlichen, deren Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Hilfezentrums lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    Die Vergabe von content:write oder content:publish schließt content:read ein. Vor der Einführung von Scopes ausgestellte Schlüssel haben null Scopes = vollständigen Zugriff (Legacy-Modus).

Request Body

application/json
  • description string erforderlich

    Aufgabenbeschreibung, die erklärt, was erstellt oder aktualisiert werden soll.

  • title string

    Optionaler Aufgabentitel. Wenn nicht angegeben, generiert Fern nach der Aufgabenerstellung einen Titel.

Response

application/json
  • id string

    Aufgaben-ID (tsk_...).

  • title string | null

    Aufgabentitel. Wenn beim Erstellen nicht angegeben, generiert Fern nach der Aufgabenerstellung einen Titel.

  • status string

    Status der Aufgabenverarbeitung.