Ferndesk

Tâches

Obtenir une tâche

Récupérer une tâche avec ses sorties : les articles, collections et sections que la tâche a proposés ou appliqués, y compris l’opération, le statut et les ID cibles. Nécessite le scope content:write.

Scope requis : content:write

GET /tasks/{id}

Obtenir une tâche

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>"
    }
  ]
}

Tâche avec sorties

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un token Bearer dans l’en-tête Authorization. Les clés API sont préfixées par fdsk_ et doivent rester secrètes. Vous pouvez générer et gérer les clés depuis la page Developer settings.

    Les clés peuvent être limitées à n’importe quel sous-ensemble de ces scopes (chaque endpoint indique le scope requis via x-required-scopes) :

    • content:read : Lire et rechercher les articles, collections, sections et traductions du centre d’aide
    • content:write : Créer et modifier des brouillons d’articles, des utilisateurs et des tâches ; déplacer des articles et des collections
    • content:publish : Publier, dépublier, restaurer et mettre du contenu à la corbeille (rendre les modifications visibles)
    • analytics:read : Lire les rapports, les analyses et les retours sur les articles du centre d’aide
    • conversations:read : Lire les conversations et transcriptions de l’assistant IA
    • webhooks:manage : Créer et gérer les abonnements aux webhooks sortants

    Accorder content:write ou content:publish implique content:read. Les clés créées avant la mise en place des scopes ont des null scopes = accès complet (mode hérité).

Path Parameters

  • id string requis

    ID de ressource de l’entité demandée. Exemple: art_01JXY9AZK4KV

Response

application/json
  • id string

    ID de tâche (tsk_...).

  • title string | null

    Titre de la tâche. S’il est omis lors de la création, Fern en génère un après la création de la tâche.

  • status string

    Statut de traitement de la tâche.

  • outputs[] object array

    Modifications de contenu produites par cette tâche. Une seule sortie de tâche (modification proposée ou appliquée).

    + 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