Ferndesk

Tareas

Obtener una tarea

Recupera una tarea con sus resultados: los artículos, las colecciones y las secciones que la tarea propuso o aplicó, incluidos la operación, el estado y los IDs de destino. Requiere el ámbito content:write.

Ámbito requerido: content:write

GET /tasks/{id}

Obtener una tarea

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

Tarea con resultados

Authorizations

  • Authorization string obligatorio header

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

    Las claves se pueden restringir a cualquier subconjunto de estos ámbitos (cada endpoint indica el ámbito 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, anular la publicación, restaurar y enviar contenido a la papelera (hacer efectivos los cambios)
    • analytics:read: Leer informes, análisis 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

    Otorgar content:write o content:publish implica content:read. Las claves creadas antes de la asignación de ámbitos tienen ámbitos nulos = acceso total (modo heredado).

Path Parameters

  • id string obligatorio

    ID del recurso de la entidad solicitada Ejemplo: art_01JXY9AZK4KV

Response

application/json
  • id string

    ID de la 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.

  • outputs[] object array

    Cambios de contenido producidos por esta tarea. Un único resultado de tarea (cambio propuesto o aplicado).

    + 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