Public Endpoints
Help Center

POST One-off Question

post
https://api.conveyor.com/api/v2/single_question

Answer a single question.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

You can get a list of product_line_ids by calling the GET Product Lines API Endpoint.

Body Params
string
required

Question text

string

(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.

string
enum
Defaults to free_response

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

Allowed:
multiple_choice_options
array of strings

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

multiple_choice_options
string
enum

(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.

Allowed:
string

(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.

Headers
string

Your Conveyor API Key

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 months ago