Ferndesk

Borradores de artículos

Obtener un borrador de artículo

Devuelve un borrador con su contenido. Usa format=markdown para Markdown. Requiere el scope content:write.

Scope requerido: content:write

GET /articles/{id}/drafts/{draftId}

Obtener un borrador de artículo

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/drafts/{DRAFTID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "language": "<string>",
  "status": "<string>",
  "baseVersion": 1,
  "source": "<string>",
  "stale": true,
  "updatedAt": "<string>",
  "title": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>"
}

Borrador

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 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, despublicar, 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 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 la asignación de scopes tienen scopes nulos = acceso completo (modo heredado).

Path Parameters

  • draftId string obligatorio

    ID del borrador. Ejemplo: drft_01JXY9AZK4KV

  • id string obligatorio

    ID del artículo de Ferndesk (art_...). Ejemplo: art_01JXY9AZK4KV

Query Parameters

  • format string enum

    Formato de representación del contenido. html (predeterminado) devuelve contentHtml; markdown devuelve contentMarkdown; json devuelve contentJson, el documento ProseMirror/Tiptap sin procesar almacenado. El JSON usa el esquema ProseMirror de Ferndesk (nodos personalizados como callout, steps y cards) y es la representación sin pérdidas del cuerpo del artículo. Ejemplo: markdown

Response

application/json
  • id string

    ID del borrador.

  • language string | null

    Idioma del borrador.

  • status string

    Estado del borrador.

  • baseVersion integer

    Versión del artículo en la que se basó el borrador.

  • source string | null

    Canal de escritura que creó el borrador.

  • stale boolean

    Indica si el artículo ha avanzado desde que se creó el borrador (solo borradores principales).

  • updatedAt string

    Marca de tiempo ISO 8601 en UTC.

  • title string | null

    Título del borrador.

  • contentHtml string

    Cuerpo del borrador como HTML (format=html).

  • contentMarkdown string

    Cuerpo del borrador como Markdown (format=markdown).

  • contentJson any | null

    Cuerpo del borrador ProseMirror/Tiptap sin procesar almacenado (format=json). Esquema ProseMirror de Ferndesk sin pérdidas.