Ferndesk

Tareas

Crear una tarea

Crea una nueva tarea y la pone en cola para el procesamiento de IA. Las tareas te permiten indicar a la IA de Ferndesk que genere o actualice artículos del centro de ayuda según tu descripción.

Requiere el scope content:write. Límite de solicitudes: 10 solicitudes por hora por API key.

Scope requerido: content:write

POST /tasks

Crear una tarea

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

Tarea creada

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las API keys tienen el prefijo fdsk_ y deben mantenerse secretas. Puedes generar y administrar claves desde la página de configuración para desarrolladores.

    Las claves pueden restringirse a cualquier subconjunto de estos scopes (cada endpoint indica el scope que requiere mediante x-required-scopes):

    • content:read: Leer y buscar artículos, colecciones, secciones y traducciones del centro de ayuda
    • content:write: Crear y editar borradores de artículos, usuarios y tareas; mover artículos y colecciones
    • content:publish: Publicar, retirar la publicación, restaurar y enviar contenido a la papelera (hacer que los cambios sean visibles)
    • analytics:read: Leer informes, analíticas y comentarios sobre artículos del centro de ayuda
    • conversations:read: Leer conversaciones y transcripciones del asistente de IA
    • webhooks:manage: Crear y administrar suscripciones a webhooks salientes

    Conceder content:write o content:publish implica content:read. Las claves creadas antes de definir scopes tienen scopes nulos = acceso total (modo heredado).

Request Body

application/json
  • description string obligatorio

    Descripción de la tarea que explica qué debe generarse o actualizarse.

  • title string

    Título opcional de la tarea. Si se omite, Fern genera uno después de crear la tarea.

Response

application/json
  • id string

    ID de tarea (tsk_...).

  • title string | null

    Título de la tarea. Si se omite al crearla, Fern genera uno después de crear la tarea.

  • status string

    Estado de procesamiento de la tarea.