List pending question requests

Retrieve pending question requests for a location.

GET/api/question/request

Query parameters

locationobject | any

Responses

200Success

locationLocation.Inforequired

Show properties

directorystringrequired

workspaceIDobject

Show properties

object

projectobjectrequired

Show properties

idstringrequired

directorystringrequired

dataQuestionV2.Request[]required

Show properties

Array of QuestionV2.Request

idobjectrequired

Show properties

object

sessionIDobjectrequired

Show properties

object

questionsQuestionV2.Info[]required

Questions to ask

Show properties

Array of QuestionV2.Info

questionstringrequired

Complete question

headerstringrequired

Very short label (max 30 chars)

optionsQuestionV2.Option[]required

Available choices

Show properties

Array of QuestionV2.Option

labelstringrequired

Display text (1-5 words, concise)

descriptionstringrequired

Explanation of choice

multipleboolean

customboolean

toolQuestionV2.Tool

Show properties

messageIDstringrequired

callIDstringrequired

400InvalidRequestError

_tagstringrequired

Allowed:InvalidRequestError

messagestringrequired

kindstring | any

Show properties

Any of:

string

string

any

any

fieldstring | any

Show properties

Any of:

string

string

any

any

401UnauthorizedError

_tagstringrequired

Allowed:UnauthorizedError

messagestringrequired

Request

curl -X GET "/api/question/request"

const response = await fetch("/api/question/request", {
  method: "GET"
});

import requests

response = requests.get(
    "/api/question/request",
)

Response

{
  "location": {
    "directory": "string",
    "workspaceID": {},
    "project": {
      "id": "string",
      "directory": "string"
    }
  },
  "data": [
    {
      "id": {},
      "sessionID": {},
      "questions": [
        {
          "question": "string",
          "header": "string",
          "options": [
            {
              "label": "string",
              "description": "string"
            }
          ],
          "multiple": true,
          "custom": true
        }
      ],
      "tool": {
        "messageID": "string",
        "callID": "string"
      }
    }
  ]
}