Authorizations
- Authorization string obligatorio header
Todas las solicitudes requieren un token Bearer en el encabezado
Authorization. Las claves de API tienen el prefijofdsk_y deben mantenerse secretas. Puedes generar y administrar claves desde la página de Configuración del desarrollador.Las claves pueden restringirse a cualquier subconjunto de estos alcances (cada endpoint indica el alcance que requiere mediante
x-required-scopes):content:read: Leer y buscar artículos, colecciones, secciones y traducciones del centro de ayudacontent:write: Crear y editar borradores de artículos, usuarios y tareas; mover artículos y coleccionescontent:publish: Publicar, retirar la publicación, restaurar y enviar contenido a la papelera (hacer que los cambios sean visibles)analytics:read: Leer informes, análisis y comentarios sobre artículos del centro de ayudaconversations:read: Leer conversaciones y transcripciones del asistente de IAwebhooks:manage: Crear y administrar suscripciones a webhooks salientes
Otorgar
content:writeocontent:publishimplicacontent:read. Las claves creadas antes de la asignación de alcances tienen alcances nulos = acceso total (modo heredado).
Query Parameters
- page_size integer
Número de elementos que se devolverán por página (1-100). Ejemplo: 20
- start_cursor string
Cursor de paginación opaco. Pasa el
next_cursorde una respuesta anterior para obtener la página siguiente. Ejemplo: eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ - status string
Filtrar por estado de la tarea. Ejemplo: completed
Response
application/json- results[] object array
Elementos de esta página. Carga útil de la tarea.
+ - Show Child Attributes
- 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.
- has_more boolean
Indica si hay más elementos disponibles después de esta página.
- next_cursor string | null
Cursor que se debe pasar como
start_cursorpara la página siguiente, o null en la última página.