POST Curated Q&A

Create a curated Q&A pair in the Knowledge Base. Requires the "Write" Knowledge Base Question permission on the API key.

post/v2/knowledge_base/questions

Request body

contentstring required

The question text.

answerstring required

The curated answer text.

status'verified' | 'unverified' required

Verification status for the Knowledge Base question.

product_line_idsstring[]

UUIDs of product lines to scope the Q&A to.

question_answering_usage'always' | 'test_only' | 'non_test_only'

How this Q&A is used for question answering.

curator_emailstring email

Email of the Q&A owner or curator. Must be a user in your organization.

question_tag_idsstring[]

Question tag UUIDs to apply to this Q&A. Tags are program-scoped.

max_verification_agenumber

Custom verification period in seconds. Must be positive.

Response

Knowledge Base question created successfully.

idstring required

UUID of the question.

questionstring required

The question text.

answerstring required

The curated answer text.

status'verified' | 'unverified' required

Verification status for the question.

created_atstring date-time required

ISO 8601 datetime when the question was created.

updated_atstring date-time required

ISO 8601 datetime when the question was last updated.

curatorstring nullable

Display name of the question curator.

last_verified_atstring date-time nullable

ISO 8601 datetime of last verification.

max_verification_agenumber required

Max verification age in seconds.

use_for_question_answeringboolean required

Whether ConveyorAI uses this Q&A.

question_answering_usage'always' | 'test_only' | 'non_test_only' required

How this Q&A is used for question answering.

question_domainsstring[] required

Security domain categories.

publicly_accessibleboolean

Whether the Q&A is shared on the Trust Center.

Changes

No recorded changes to this endpoint across all 1 revision of this API.