Ferndesk

Tâches

Créer une tâche

Crée une nouvelle tâche et la met en file d’attente pour le traitement par IA. Les tâches vous permettent de demander à l’IA de Ferndesk de générer ou de mettre à jour des articles du centre d’aide à partir de votre description.

Nécessite le scope content:write. Limite de débit : 10 requêtes par heure et par clé API.

Scope requis : content:write

POST /tasks

Créer une tâche

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

Tâche créée

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un jeton 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 Paramètres développeur.

    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 des 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 déplacer du contenu vers la corbeille (rendre les modifications accessibles)
    • analytics:read : Lire les rapports, analyses et 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 des abonnements aux webhooks sortants

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

Request Body

application/json
  • description string requis

    Description de la tâche expliquant ce qui doit être généré ou mis à jour.

  • title string

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

Response

application/json
  • id string

    ID de la 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 du traitement de la tâche.