Ferndesk

Tasks

Create a task

Creates a new task and queues it for AI processing. Tasks let you instruct Ferndesk's AI to generate or update help center articles based on your description.

Requires the content:write scope. Rate limit: 10 requests per hour per API key.

Required scope: content:write

POST /tasks

Create a task

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

Created task

Authorizations

  • Authorization string required header

    All requests require a Bearer token in the Authorization header. API keys are prefixed with fdsk_ and should be kept secret. You can generate and manage keys from the Developer settings page.

    Keys can be restricted to any subset of these scopes (each endpoint lists the scope it requires via x-required-scopes):

    • content:read: Read and search help center articles, collections, sections, and translations
    • content:write: Create and edit article drafts, users, tasks; move articles and collections
    • content:publish: Publish, unpublish, restore, and trash content (make changes live)
    • analytics:read: Read help center reporting, analytics, and article feedback
    • conversations:read: Read AI assistant conversations and transcripts
    • webhooks:manage: Create and manage outbound webhook subscriptions

    Granting content:write or content:publish implies content:read. Keys minted before scoping have null scopes = full access (legacy mode).

Request Body

application/json
  • description string required

    Task description explaining what should be generated or updated.

  • title string

    Optional task title. If omitted, Fern generates one after task creation.

Response

application/json
  • id string

    Task ID (tsk_...).

  • title string | null

    Task title. If omitted on create, Fern generates one after task creation.

  • status string

    Task processing status.