FAQ Tasks

Generate FAQ questions

post

Submit a request to generate FAQ questions from a Knowledge Base. Returns a task ID for tracking. The actual generation will be processed asynchronously.

Body

application/json

Generate FAQ questions request schema.

Attributes: task_id (str): Task identifier for tracking this generation task. knowledge_base_id (str): Knowledge Base identifier. question_count (int): Number of questions to generate. filter (tuple[str, str, str] | None): Optional filters for question generation. priority (Literal["width", "depth"]): Priority for generation strategy.

task_idstringRequired

Task identifier for tracking this generation task

knowledge_base_idstringRequired

Knowledge Base identifier

question_countinteger · min: 1 · max: 100Optional

Number of questions to generate

Default: 10

filterany ofOptional

Optional filters for question generation. key (in, gt, gte, lt, lte, eq, ne), operator, value

array · min: 3 · max: 3Optional

or

nullOptional

prioritystring · enumOptional

Priority: width first covers more topics broadly, depth first covers topics in detail

Default: depthPossible values:

Responses

201

FAQ generation request accepted and queued for processing.

application/json

400

Invalid request data

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/faq/generate-questions

HTTPcURLJavaScriptPython

POST /faq/generate-questions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "task_id": "text",
  "knowledge_base_id": "text",
  "question_count": 10,
  "filter": [],
  "priority": "depth"
}

{
  "status": "IN_PROGRESS",
  "success": true,
  "task_id": "task_12345",
  "knowledge_base_id": "kb_001",
  "message": "FAQ generation request accepted and queued for processing"
}

Get FAQ question generation task status

get

Retrieve the status of a FAQ question generation task by its task ID.

Path parameters

task_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/faq/get-status/{task_id}

HTTPcURLJavaScriptPython

GET /faq/get-status/{task_id} HTTP/1.1
Host: 
Accept: */*

{
  "task_id": "text",
  "knowledge_base_id": "text",
  "status": "IN_PROGRESS"
}