Generate FAQs

curl --request POST \
  --url https://api.webless.ai/api/v1/faqs \
  --header 'Content-Type: application/json' \
  --data '
{
  "company": "YOUR_COMPANY",
  "canonical_url": "https://example.com/articles/product-launch"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    company: 'YOUR_COMPANY',
    canonical_url: 'https://example.com/articles/product-launch'
  })
};

fetch('https://api.webless.ai/api/v1/faqs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.webless.ai/api/v1/faqs"

payload = {
    "company": "YOUR_COMPANY",
    "canonical_url": "https://example.com/articles/product-launch"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "status": "ready",
  "items": [
    {
      "question": "What does the product launch introduce?",
      "answer": "The launch introduces a faster setup flow while keeping existing integrations compatible."
    },
    {
      "question": "Who can use the new experience?",
      "answer": "The new experience is available to all customers."
    }
  ],
  "source_url": "https://example.com/articles/product-launch",
  "title": "Product launch",
  "cache_status": "miss",
  "version": "published",
  "resolved_version": "published",
  "resolved_corpus_version": 12,
  "generated_at": "2026-06-12T19:30:00+00:00"
}

POST

api

faqs

Generate FAQs

curl --request POST \
  --url https://api.webless.ai/api/v1/faqs \
  --header 'Content-Type: application/json' \
  --data '
{
  "company": "YOUR_COMPANY",
  "canonical_url": "https://example.com/articles/product-launch"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    company: 'YOUR_COMPANY',
    canonical_url: 'https://example.com/articles/product-launch'
  })
};

fetch('https://api.webless.ai/api/v1/faqs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.webless.ai/api/v1/faqs"

payload = {
    "company": "YOUR_COMPANY",
    "canonical_url": "https://example.com/articles/product-launch"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "status": "ready",
  "items": [
    {
      "question": "What does the product launch introduce?",
      "answer": "The launch introduces a faster setup flow while keeping existing integrations compatible."
    },
    {
      "question": "Who can use the new experience?",
      "answer": "The new experience is available to all customers."
    }
  ],
  "source_url": "https://example.com/articles/product-launch",
  "title": "Product launch",
  "cache_status": "miss",
  "version": "published",
  "resolved_version": "published",
  "resolved_corpus_version": 12,
  "generated_at": "2026-06-12T19:30:00+00:00"
}

Generate page-specific questions and answers from content already indexed for a page. Use the page’s canonical URL to identify the content.

Send URL context only. Do not send the full page body from the browser. The API returns not_found when the page is not available in the selected index.

Format the answers

Goal	Field
Return between one and six questions	Set `max_items`. The default is `4`.
Return prose answers	Set `answer_format` to `paragraph`. Use `answer_paragraph_words` to target `50`, `100`, or `150` words.
Return list answers	Set `answer_format` to `bullets`. Use `answer_max_bullets` to return between one and six list items.
Adjust the writing style	Set `tone` to `neutral`, `warm`, `professional`, or `concise`.
Test unpublished runtime changes	Set `version` to `unpublished`. Production requests default to `published`.
Bypass the cache and summary analytics	Set `is_private_session` to `true` or `tracking_consent` to `false`.

A bullet-formatted answer is one string containing newline-separated list items. It is not an array.

Handle the response status

The endpoint returns HTTP 200 for each application-level result.

Status	Meaning
`ready`	`items` contains the generated question-and-answer pairs.
`not_found`	The page is not in the selected index. `items` is empty.
`error`	The API could not produce usable FAQs.

Body

application/json

company

string

required

Public company or index identifier.

canonical_url

string

required

Canonical URL of the page used to generate FAQs.

page_url

string

Current browser URL. Optional; fragments and tracking params are normalized server-side.

title

string

Optional page title for display and prompt context.

locale

string

Optional locale or language hint.

requestId

string

Caller-generated request identifier.

sessionId

string

Caller-generated session identifier.

is_private_session

boolean

default:false

When true, bypasses the cache and summary analytics logging.

Tracking consent for this request. Setting this to false also enables private-session behavior.

model

string

default:gpt

Model alias configured for the runtime package.

version

enum<string>

default:published

Runtime package pointer. Omit this field or use published for production traffic. Use unpublished only when testing an unpublished runtime package.

Available options:

published,

unpublished

max_items

integer

default:4

Maximum number of question-and-answer pairs to return.

Required range: 1 <= x <= 6

answer_format

enum<string>

default:paragraph

Format for each answer.

Available options:

paragraph,

bullets

answer_max_bullets

integer

default:3

Maximum list items in each answer when answer_format is bullets.

Required range: 1 <= x <= 6

answer_paragraph_words

enum<integer>

default:100

Target word count for each answer when answer_format is paragraph.

Available options:

50,

100,

150

tone

enum<string>

default:neutral

Writing style for generated answers.

Available options:

neutral,

warm,

professional,

concise

Response

FAQ result for the supplied page URL

status

enum<string>

required

FAQ generation status.

Available options:

ready,

not_found,

error

items

object[]

required

Generated question-and-answer pairs. Empty when status is not_found or error.

Show child attributes

cache_status

enum<string>

required

Whether the response came from cache.

Available options:

hit,

miss,

bypass

source_url

string | null

Normalized source URL used for lookup.

title

string | null

Page title returned by the request or indexed content.

version

enum<string>

default:published

Runtime package pointer. Omit this field or use published for production traffic. Use unpublished only when testing an unpublished runtime package.

Available options:

published,

unpublished

resolved_version

string | null

Resolved runtime pointer after fallback handling.

resolved_corpus_version

integer | null

Resolved indexed corpus version used internally for the response.

generated_at

string<date-time> | null

Server timestamp for the generated response.

Overview

Search API

Page content API

Session API

Data API

Generate FAQs

Format the answers

Handle the response status

Body

Response

​Format the answers

​Handle the response status

Body

Response

Format the answers

Handle the response status