Skip to content
Dashboard

List Q&A entries

GET/v2/training_data/qna

Returns Q&A entries, newest first, with cursor pagination. Filter by externalId or source. Entries include their full questions and answer.

Query ParametersExpand Collapse
cursor: optional string

An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page of results.

maxLength512
externalId: optional string

Only return the entry with this externalId

minLength1
maxLength255
limit: optional number

A limit on the number of objects to be returned, between 1 and 100.

minimum1
maximum100
source: optional string

Only return entries with this source label

minLength1
maxLength100
Header ParametersExpand Collapse
"Featurebase-Version": optional "2026-08-19.orbit" or "2026-01-01.nova" or "2025-12-12.clover"
One of the following:
"2026-08-19.orbit"
"2026-01-01.nova"
"2025-12-12.clover"
ReturnsExpand Collapse
data: array of Qna { id, answer, createdAt, 10 more }

Array containing the actual response elements

id: string

Q&A entry ID

answer: string

The answer the AI agent gives (markdown)

createdAt: string

ISO timestamp of creation

externalId: string

Stable identifier supplied by the source system

indexStatus: "pending" or "indexed" or "failed"

Whether the entry is searchable by the AI agent. failed entries are stored and indexing is retried hourly up to three times. Re-send the resource to retry after exhaustion.

One of the following:
"pending"
"indexed"
"failed"
object: "qna"

Object type identifier

questions: array of string

Question variants the answer applies to

revision: number

Q&A revision. Send it as expectedRevision on PATCH to reject stale changes.

source: string

Pipeline label, if one was set

title: string

Short label for the entry

updatedAt: string

ISO timestamp of the last change

match: optional object { entry, reason, verdict }

Present only when onMatch was passed and the check ran: the verdict and the closest existing item, even when the write went ahead. null otherwise (the default), including when the payload was unchanged.

entry: object { id, kind, section, 3 more }

The existing item the verdict is about, or null when nothing was close

id: string

ID of the item (Q&A entry, training file, or article)

kind: "qna" or "training_file" or "help_center_article"

What kind of knowledge item matched: a Q&A entry, a training file / crawled page, or a live help-center article.

One of the following:
"qna"
"training_file"
"help_center_article"
section: string

Heading breadcrumb of the matching section, for training files

similarity: number

Cosine similarity between your entry and the item (0–1); null for a keyword-only hit

title: string

Title of the item

url: string

Public URL of the item when it has one (articles, crawled pages)

reason: string

The judge’s one-line explanation of the verdict

verdict: "same_topic" or "contradicts" or "different" or 2 more

How the closest existing item relates to the entry. same_topic: it answers the same customer question (the entry would be a duplicate, rewording, or updated version). contradicts: same question, incompatible facts. different: a different question, even if the wording overlaps. unclear: the judge could not decide. no_match: nothing similar was found.

One of the following:
"same_topic"
"contradicts"
"different"
"unclear"
"no_match"
outcome: optional "created" or "updated" or "unchanged"

What the write did — present on create and update responses. created: a new entry. updated: an entry already carried one of the questions (or was merged into with onMatch: "update") and got new content or an indexing retry. unchanged: everything in the payload was already on that entry; nothing written, nothing re-indexed.

One of the following:
"created"
"updated"
"unchanged"
nextCursor: string

Cursor to use for fetching the next page. Null if there are no more results.

maxLength512
object: "list"

String representing the object type

List Q&A entries

curl https://do.featurebase.app/v2/training_data/qna \
    -H "Authorization: Bearer $FEATUREBASE_API_KEY"
{
  "data": [
    {
      "id": "67ec1234abcd5678ef901235",
      "answer": "You can request a refund within 30 days from **Settings → Billing**.",
      "createdAt": "2026-09-03T10:15:00.000Z",
      "externalId": "resolution-1842",
      "indexStatus": "indexed",
      "object": "qna",
      "questions": [
        "How do I request a refund?",
        "Can I get my money back?"
      ],
      "revision": 1,
      "source": "resolved-conversations",
      "title": "Refund requests",
      "updatedAt": "2026-09-03T10:15:30.000Z",
      "match": {
        "entry": {
          "id": "67ec1234abcd5678ef901236",
          "kind": "qna",
          "section": null,
          "similarity": 0.61,
          "title": "Refund requests",
          "url": null
        },
        "reason": "Both answer how to request a refund; the new entry adds the 30-day window.",
        "verdict": "same_topic"
      },
      "outcome": "created"
    }
  ],
  "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9",
  "object": "list"
}
Returns Examples
{
  "data": [
    {
      "id": "67ec1234abcd5678ef901235",
      "answer": "You can request a refund within 30 days from **Settings → Billing**.",
      "createdAt": "2026-09-03T10:15:00.000Z",
      "externalId": "resolution-1842",
      "indexStatus": "indexed",
      "object": "qna",
      "questions": [
        "How do I request a refund?",
        "Can I get my money back?"
      ],
      "revision": 1,
      "source": "resolved-conversations",
      "title": "Refund requests",
      "updatedAt": "2026-09-03T10:15:30.000Z",
      "match": {
        "entry": {
          "id": "67ec1234abcd5678ef901236",
          "kind": "qna",
          "section": null,
          "similarity": 0.61,
          "title": "Refund requests",
          "url": null
        },
        "reason": "Both answer how to request a refund; the new entry adds the 30-day window.",
        "verdict": "same_topic"
      },
      "outcome": "created"
    }
  ],
  "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9",
  "object": "list"
}