Skip to main content
POST
/
v5
/
questions
Create Question
curl --request POST \
  --url https://api.egp.scale.com/v5/questions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "prompt": "<string>",
  "configuration": {
    "choices": [
      "<string>"
    ],
    "multi": true,
    "dropdown": true
  },
  "conditions": [
    {}
  ],
  "question_type": "categorical"
}
'
{
  "id": "<string>",
  "created_by": {
    "id": "<string>",
    "object": "identity"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "prompt": "<string>",
  "configuration": {
    "choices": [
      "<string>"
    ],
    "multi": true,
    "dropdown": true
  },
  "object": "question",
  "conditions": [
    {}
  ],
  "archived_at": "2023-11-07T05:31:56Z",
  "question_type": "categorical"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string | null

Body

application/json
​
name
string
required
​
prompt
string
required

user-facing question prompt

​
configuration
CategoricalQuestionConfiguration · object
required
​
conditions
Conditions · object[]

Conditions for the question to be shown

​
question_type
string
default:categorical
Allowed value: "categorical"

Response

Successful Response

​
id
string
required

Unique identifier of the entity

​
created_by
Identity · object
required

The identity that created the entity.

​
created_at
string<date-time>
required

ISO-timestamp when the entity was created

​
name
string
required
​
prompt
string
required

user-facing question prompt

​
configuration
CategoricalQuestionConfiguration · object
required
​
object
string
default:question
Allowed value: "question"
​
conditions
Conditions · object[]

Conditions for the question to be shown

​
archived_at
string<date-time>

ISO-timestamp when the entity was archived

​
question_type
string
default:categorical
Allowed value: "categorical"