Ferndesk

Tasks

Eine Task abrufen

Eine Task mit ihren Outputs abrufen: die Artikel, Sammlungen und Abschnitte, die die Task vorgeschlagen oder angewendet hat, einschließlich Operation, Status und Ziel-IDs. Erfordert den Scope content:write.

Erforderlicher Scope: content:write

GET /tasks/{id}

Eine Task abrufen

curl --request GET \
  --url 'https://api.ferndesk.com/v1/tasks/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "title": "<string>",
  "status": "<string>",
  "outputs": [
    {
      "id": "<string>",
      "kind": "<string>",
      "operation": "<string>",
      "status": "<string>",
      "title": "<string>",
      "targetArticleId": "<string>",
      "targetCollectionId": "<string>",
      "targetSectionId": "<string>",
      "appliedAt": "<string>"
    }
  ]
}

Task mit Outputs

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel haben das Präfix fdsk_ und sollten geheim gehalten werden. Sie können Schlüssel über die 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: Hilfecenter-Artikel, Sammlungen, Abschnitte und Übersetzungen lesen und durchsuchen
    • content:write: Artikelentwürfe, Benutzer und Tasks 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 Hilfecenters 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 beinhaltet content:read. Für vor der Einführung von Scopes ausgestellte Schlüssel gilt: null scopes = Vollzugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

    Ressourcen-ID der angeforderten Entität. Beispiel: art_01JXY9AZK4KV

Response

application/json
  • id string

    Task-ID (tsk_...).

  • title string | null

    Titel der Task. Wenn beim Erstellen kein Titel angegeben wird, generiert Fern nach der Erstellung der Task einen Titel.

  • status string

    Verarbeitungsstatus der Task.

  • outputs[] object array

    Inhaltliche Änderungen, die diese Task erzeugt hat. Ein einzelnes Task-Output (vorgeschlagene oder angewendete Änderung).

    + Show Child Attributes
    • id string
    • kind string
    • operation string
    • status string
    • title string
    • targetArticleId string | null
    • targetCollectionId string | null
    • targetSectionId string | null
    • appliedAt string | null