Ferndesk

Artikelentwürfe

Artikelentwurf erstellen

Erstellt einen offenen Entwurf für einen Artikel. Übergeben Sie language für einen Übersetzungsentwurf. Erfordert den Scope content:write.

Erforderlicher Scope: content:write

POST /articles/{id}/drafts

Artikelentwurf erstellen

curl --request POST \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/drafts' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "language": "<string>",
  "status": "<string>",
  "baseVersion": 1,
  "source": "<string>",
  "stale": true,
  "updatedAt": "<string>"
}

Entwurf erstellt

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel tragen das Präfix fdsk_ und sollten geheim gehalten werden. Sie können Schlüssel über die Seite Entwicklereinstellungen erstellen und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt führt den über x-required-scopes erforderlichen Scope auf):

    • content:read: Hilfezentrumsartikel, Sammlungen, Abschnitte und Übersetzungen lesen und durchsuchen
    • content:write: Artikelentwürfe und Benutzer erstellen und bearbeiten sowie Aufgaben verwalten; Artikel und Sammlungen verschieben
    • content:publish: Inhalte veröffentlichen, die Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Hilfezentrums lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    content:write oder content:publish zu gewähren, schließt content:read ein. Vor der Einführung von Scopes ausgestellte Schlüssel haben null Scopes = vollständiger Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

    Ressourcen-ID der angeforderten Entität. Beispiel: art_01JXY9AZK4KV

Request Body

application/json
  • title string

    Titel des Entwurfs.

  • content any

    Inhalt des Entwurfs (Tiptap JSON).

  • markdown string

    Inhalt des Entwurfs als Markdown.

  • language string

    Sprache für einen Übersetzungsentwurf. Für die Primärsprache weglassen.

Response

application/json
  • id string

    ID des Entwurfs.

  • language string | null

    Sprache des Entwurfs.

  • status string

    Status des Entwurfs.

  • baseVersion integer

    Artikelversion, auf der der Entwurf basiert.

  • source string | null

    Schreibkanal, über den der Entwurf erstellt wurde.

  • stale boolean

    Gibt an, ob sich der Artikel weiterentwickelt hat, seit der Entwurf darauf basiert wurde (nur primäre Entwürfe).

  • updatedAt string

    ISO-8601-Zeitstempel in UTC.