Sign in

v1

latestOpenAPI 3.1.02026-07-24300110.4 KB

POST One-off Question

Answer a single question.

post/v2/single_question

Headers

X-API-KEYstring

Your Conveyor API Key

Request body

questionstring required

Question text

product_line_idsstring

(Optional) Comma separated Product Line UUIDs. These are the applicable product lines for the question. You can also leave this blank if applicable to all product lines.

question_type'"free_response"' | '"select_one"' | '"select_multiple"'

(Optional) Can be "free_response", "select_one", "select_multiple"

multiple_choice_optionsstring[]

(Optional) Multiple choice options for the answer. This must be provided if question_type is "select_one" or "select_multiple".

confidence_threshold'high' | 'medium' | 'low'

(Optional) If provided, only return an answer and answer_confidence if its confidence level is equal or higher than threshold. By default always returns the answer and the answer_confidence level. Valid options: high, medium, low.

emailstring

(Optional) Email address for analytics. If not provided, we default to the email address associated with the person who first created the Conveyor API Key.

Response

201

OR
OR

Example response

{
  "id": "123",
  "question": "Do you encrypt data?",
  "answer": "?"
}