Open Question API

Open Question API (OQAPI) is the question-generation technology from questioning.ai family. It is embedded into a REST API interface. It is built with the purpose to enable coaching questioning capabilities in software or hypbrid hardware/software systems. The examples are learning management systems (LMS), chatbot assistants, human-assisted applications, assistive robotics, and others.

Request access by writitng us about your use-case via https://pocketconfidant.com/oqapi/

All questioning.ai documentation is available via https://docs.questioning.ai

questioning.ai is owned and managed by PocketConfidant AI SAS

More information: https://pocketconfidant.com/contact/
Contact Info: oqapi@questioning.ai
Version: 1.0
BasePath:/v1
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. APIKey KeyParamName:oqapi-subscription-key KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Table of Contents

Availability

Endpoints

QuestionGeneration

Availability

Up 
get /wakeup
GET Wake-up endpoint (getWakeup)
Sending this request allows to minimize response time of the OQAPI thanks to waking it up before sending the actual request.

Request headers

Return type

inline_response_200_2

Example data

Content-Type: application/json
{
  "output" : {
    "successMessage" : "successMessage",
    "statusCode" : 6.027456183070403
  },
  "input" : "input",
  "api" : {
    "build" : 6.027456183070403,
    "name" : "name",
    "version" : 0.8008281904610115
  },
  "oexp" : {
    "verion" : "verion",
    "terms" : "terms",
    "privacy" : "privacy"
  },
  "timestamp" : 0.8008281904610115
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Example response inline_response_200_2

Example data

Content-Type: example-1

Endpoints

Up 
get /wakeup
GET Wake-up endpoint (getWakeup)
Sending this request allows to minimize response time of the OQAPI thanks to waking it up before sending the actual request.

Request headers

Return type

inline_response_200_2

Example data

Content-Type: application/json
{
  "output" : {
    "successMessage" : "successMessage",
    "statusCode" : 6.027456183070403
  },
  "input" : "input",
  "api" : {
    "build" : 6.027456183070403,
    "name" : "name",
    "version" : 0.8008281904610115
  },
  "oexp" : {
    "verion" : "verion",
    "terms" : "terms",
    "privacy" : "privacy"
  },
  "timestamp" : 0.8008281904610115
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Example response inline_response_200_2

Example data

Content-Type: example-1
Up 
post /questions
POST Questions endpoint (postQuestions)
Operation retrieves the list of generated questions, plus additional metadata, such as timestamp, API versioning, and others. Unlike /sentences/ endpoint, requests to /questions/ endpoint will always supply one or multiple questions. These questions are either specific to linguistic markers, or generic, without the referrence to a phrase.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter — <p>For a POST request, you can use the <code>body</code> property to pass a JSON string as input. Note that the request body should be a JSON string, while the headers should be a JSON object. The request body must contain non-empty string <code>story</code>, for which the questions will be generated.</p> <p>To control how questions are provided in the response output, <code>options</code> could be used.</p> <ul> <li><strong>verbosity</strong>: use <code>{&quot;verbose&quot;: false}</code> for compact questions and statements provided separately. Use <code>{&quot;verbose&quot;: true}</code> for questions and statements provided in the same varible.</li> </ul>
example: { "value" : { "story" : "In all cases, I don’t like to intentionally look for a solution, an answer or a different perspective. Demanding something doesn’t seem to lead to a breakthrough. Humbly yes, surrendering my attempts to figure it all out on my own, creates new paths and opens doors. I just can't do this all the time.", "options" : { "verbose" : true } } }

Request headers

Return type

inline_response_200_1

Example data

Content-Type: application/json
{
  "output" : {
    "questions" : [ {
      "phrase" : "phrase",
      "domain" : "domain",
      "scope" : "scope",
      "markdown" : "markdown",
      "statement" : "statement",
      "html" : "html",
      "id" : "id",
      "type" : "type",
      "methodology" : "methodology"
    }, {
      "phrase" : "phrase",
      "domain" : "domain",
      "scope" : "scope",
      "markdown" : "markdown",
      "statement" : "statement",
      "html" : "html",
      "id" : "id",
      "type" : "type",
      "methodology" : "methodology"
    } ]
  },
  "input" : {
    "story" : "story"
  },
  "api" : {
    "build" : 6.027456183070403,
    "name" : "name",
    "version" : 0.8008281904610115
  },
  "oexp" : {
    "verion" : "verion",
    "terms" : "terms",
    "privacy" : "privacy"
  },
  "timestamp" : 0.8008281904610115
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Example response inline_response_200_1

Example data

Content-Type: 200-questions-with-statements
{"api":{"version":1,"build":17,"name":"Open Question API"},"timestamp":1.6250052007122636E9,"input":{"story":"When in my thoughts I'm coming back to my situation, I'd want make things happen now.","options":{"verbose":false}},"output":{"questions":[{"id":"5e3b233dbaac8fabfdd9357f881b91b9d5cef731ea62abe7e647b029_q01","markdown":"You said **back to my**, how can you do that, what specific easily achievable decision or action can you make?","html":"<span class=\"question\">You said <strong class=\"phrase\">back to my</strong>, how can you do that, what specific easily achievable decision or action can you make?</span>","statement":"Identifying and defining this element will make your path more achievable."}]},"oexp":{"verion":"0.9.3","privacy":"https://pocketconfidant.com/privacy/","terms":"https://pocketconfidant.com/terms/"}}

Example data

Content-Type: 200-questions-verbose-1
{"api":{"version":1,"build":17,"name":"Open Question API"},"timestamp":1.62500522054872E9,"input":{"story":"In all cases, I don’t like to intentionally look for a solution, an answer or a different perspective. Demanding something doesn’t seem to lead to a breakthrough. Humbly yes, surrendering my attempts to figure it all out on my own, creates new paths and opens doors. I just can't do this all the time.","options":{"verbose":true}},"output":{"questions":[{"id":"2a242fa9a032dea0ab696e26b6b29dcfeea9120b0ea4c0880d19454c_q01","markdown":"When you say **I do not like**, if you don't, then what do you like instead? Reflecting on what is there instead is a way to develop constructive thinking, leading to new perspectives and actions.","html":"<span class=\"question\">When you say <strong class=\"phrase\">I do not like</strong>, if you don't, then what do you like instead?</span><span class=\"statement\">Reflecting on what is there instead is a way to develop constructive thinking, leading to new perspectives and actions.</span>"},{"id":"6345f9953880d0d7243e2fd87a413dd82598a94de6c7706c6779acb0_q01","markdown":"You said **all the time**, what would you like to have happen instead? Reflecting on and defining this element precisely will help identifying what goals and actions to put in place.","html":"<span class=\"question\">You said <strong class=\"phrase\">all the time</strong>, what would you like to have happen instead?</span><span class=\"statement\">Reflecting on and defining this element precisely will help identifying what goals and actions to put in place.</span>"}]},"oexp":{"verion":"0.9.3","privacy":"https://pocketconfidant.com/privacy/","terms":"https://pocketconfidant.com/terms/"}}

Example data

Content-Type: 200-questions-verbose-2
{"api":{"version":1,"build":17,"name":"Open Question API"},"timestamp":1.625005169312257E9,"input":{"story":"When in my thoughts I'm coming back to my situation, I'd want make things happen now.","options":{"verbose":true}},"output":{"questions":[{"id":"5e3b233dbaac8fabfdd9357f881b91b9d5cef731ea62abe7e647b029_q01","markdown":"When saying **back to my**, how can you do that, what specific easily achievable decision or action can you make? Identifying and defining this element will make your path more achievable.","html":"<span class=\"question\">When saying <strong class=\"phrase\">back to my</strong>, how can you do that, what specific easily achievable decision or action can you make?</span><span class=\"statement\">Identifying and defining this element will make your path more achievable.</span>"}]},"oexp":{"verion":"0.9.3","privacy":"https://pocketconfidant.com/privacy/","terms":"https://pocketconfidant.com/terms/"}}

422

Example response inline_response_422

Example data

Content-Type: example-1
Up 
post /sentences
POST Sentences and Questions endpoint (postSentences)
Operation retrieves the analyzed text broken down into sentences with generated questions, plus additional metadata, such as timestamp, API versioning, and others. Unlike /questions/ endpoint, requests to /sentences/ endpoint supplies only questions which are specific to linguistic markers detected within each sentence. If the linguistic marker is absent, the output list of questions adjaccent to each sentences might be empty. This endpoint is useful if you want to provide a very context-specific details to your user.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter — <p>For a POST request, you can use the <code>body</code> property to pass a JSON string as input. Note that the request body should be a JSON string, while the headers should be a JSON object. The request body must contain non-empty string <code>story</code>, for which the questions will be generated.</p> <p>To control how questions are provided in the response output, <code>options</code> could be used.</p> <ul> <li><strong>verbosity</strong>: use <code>{&quot;verbose&quot;: false}</code> for compact questions and statements provided separately. Use <code>{&quot;verbose&quot;: true}</code> for questions and statements provided in the same varible.</li> </ul>
example: { "value" : { "story" : "In all cases, I don’t like to intentionally look for a solution, an answer or a different perspective. Demanding something doesn’t seem to lead to a breakthrough. Humbly yes, surrendering my attempts to figure it all out on my own, creates new paths and opens doors. I just can't do this all the time.", "options" : { "verbose" : true } } }

Request headers

Return type

inline_response_200

Example data

Content-Type: application/json
{
  "output" : {
    "sentences" : [ {
      "markdown" : "markdown",
      "questions" : [ {
        "phrase" : "phrase",
        "domain" : "domain",
        "scope" : "scope",
        "markdown" : "markdown",
        "statement" : "statement",
        "html" : "html",
        "id" : "id",
        "type" : "type",
        "methodology" : "methodology"
      }, {
        "phrase" : "phrase",
        "domain" : "domain",
        "scope" : "scope",
        "markdown" : "markdown",
        "statement" : "statement",
        "html" : "html",
        "id" : "id",
        "type" : "type",
        "methodology" : "methodology"
      } ],
      "html" : "html",
      "id" : "id"
    }, {
      "markdown" : "markdown",
      "questions" : [ {
        "phrase" : "phrase",
        "domain" : "domain",
        "scope" : "scope",
        "markdown" : "markdown",
        "statement" : "statement",
        "html" : "html",
        "id" : "id",
        "type" : "type",
        "methodology" : "methodology"
      }, {
        "phrase" : "phrase",
        "domain" : "domain",
        "scope" : "scope",
        "markdown" : "markdown",
        "statement" : "statement",
        "html" : "html",
        "id" : "id",
        "type" : "type",
        "methodology" : "methodology"
      } ],
      "html" : "html",
      "id" : "id"
    } ]
  },
  "input" : {
    "story" : "story"
  },
  "api" : {
    "build" : 6.027456183070403,
    "name" : "name",
    "version" : 0.8008281904610115
  },
  "oexp" : {
    "verion" : "verion",
    "terms" : "terms",
    "privacy" : "privacy"
  },
  "timestamp" : 1.4658129805029452
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Example response inline_response_200

Example data

Content-Type: 200-sentences-processed-with-statements
{"api":{"version":1,"build":17,"name":"Open Question API"},"timestamp":1.6250040037487648E9,"input":{"story":"In all cases, I don’t like to intentionally look for a solution, an answer or a different perspective. Demanding something doesn’t seem to lead to a breakthrough. Humbly yes, surrendering my attempts to figure it all out on my own, creates new paths and opens doors. I just can't do this all the time.","options":{"verbose":false}},"output":{"processed_text":"In cases, I don’t like intentionally look solution, answer different perspective. Demanding something doesn’t seem lead breakthrough. Humbly yes, surrendering attempts figure own, creates new paths opens doors. I can't time.","entities":[],"sentences":[{"id":"2a242fa9a032dea0ab696e26b6b29dcfeea9120b0ea4c0880d19454c","markdown":"In all cases, **I do not like** to intentionally look for a solution, an answer or a different perspective.","html":"In all cases, <strong class=\"phrase\">I do not like</strong> to intentionally look for a solution, an answer or a different perspective.","questions":[{"id":"2a242fa9a032dea0ab696e26b6b29dcfeea9120b0ea4c0880d19454c_q01","markdown":"When saying **I do not like**, if you don't, then what do you like instead?","html":"<span class=\"question\">When saying <strong class=\"phrase\">I do not like</strong>, if you don't, then what do you like instead?</span>","statement":"Reflecting on what is there instead is a way to develop constructive thinking, leading to new perspectives and actions."}]},{"id":"861ce447e81754daa07aa9b8cd5706a0655ca314eda4a924d54bff43","markdown":"Demanding something does not seem to lead to a breakthrough.","html":"Demanding something does not seem to lead to a breakthrough.","questions":[]},{"id":"5606a1ab45363a8316589fd2bbfdd5cdabd6dc7f58bb07a7e482f75c","markdown":"Humbly yes, surrendering my attempts to figure it all out on my own, creates new paths and opens doors.","html":"Humbly yes, surrendering my attempts to figure it all out on my own, creates new paths and opens doors.","questions":[]},{"id":"6345f9953880d0d7243e2fd87a413dd82598a94de6c7706c6779acb0","markdown":"I just can not do this **all the time**.","html":"I just can not do this <strong class=\"phrase\">all the time</strong>.","questions":[{"id":"6345f9953880d0d7243e2fd87a413dd82598a94de6c7706c6779acb0_q01","markdown":"When saying **all the time**, what would you like to have happen instead?","html":"<span class=\"question\">When saying <strong class=\"phrase\">all the time</strong>, what would you like to have happen instead?</span>","statement":"Reflecting on and defining this element precisely will help identifying what goals and actions to put in place."}]}]},"oexp":{"verion":"0.9.3","privacy":"https://pocketconfidant.com/privacy/","terms":"https://pocketconfidant.com/terms/"}}

Example data

Content-Type: 200-sentences-processed-verbose

422

Example response inline_response_422

Example data

Content-Type: example-1

QuestionGeneration

Up 
post /questions
POST Questions endpoint (postQuestions)
Operation retrieves the list of generated questions, plus additional metadata, such as timestamp, API versioning, and others. Unlike /sentences/ endpoint, requests to /questions/ endpoint will always supply one or multiple questions. These questions are either specific to linguistic markers, or generic, without the referrence to a phrase.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter — <p>For a POST request, you can use the <code>body</code> property to pass a JSON string as input. Note that the request body should be a JSON string, while the headers should be a JSON object. The request body must contain non-empty string <code>story</code>, for which the questions will be generated.</p> <p>To control how questions are provided in the response output, <code>options</code> could be used.</p> <ul> <li><strong>verbosity</strong>: use <code>{&quot;verbose&quot;: false}</code> for compact questions and statements provided separately. Use <code>{&quot;verbose&quot;: true}</code> for questions and statements provided in the same varible.</li> </ul>
example: { "value" : { "story" : "In all cases, I don’t like to intentionally look for a solution, an answer or a different perspective. Demanding something doesn’t seem to lead to a breakthrough. Humbly yes, surrendering my attempts to figure it all out on my own, creates new paths and opens doors. I just can't do this all the time.", "options" : { "verbose" : true } } }

Request headers

Return type

inline_response_200_1

Example data

Content-Type: application/json
{
  "output" : {
    "questions" : [ {
      "phrase" : "phrase",
      "domain" : "domain",
      "scope" : "scope",
      "markdown" : "markdown",
      "statement" : "statement",
      "html" : "html",
      "id" : "id",
      "type" : "type",
      "methodology" : "methodology"
    }, {
      "phrase" : "phrase",
      "domain" : "domain",
      "scope" : "scope",
      "markdown" : "markdown",
      "statement" : "statement",
      "html" : "html",
      "id" : "id",
      "type" : "type",
      "methodology" : "methodology"
    } ]
  },
  "input" : {
    "story" : "story"
  },
  "api" : {
    "build" : 6.027456183070403,
    "name" : "name",
    "version" : 0.8008281904610115
  },
  "oexp" : {
    "verion" : "verion",
    "terms" : "terms",
    "privacy" : "privacy"
  },
  "timestamp" : 0.8008281904610115
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Example response inline_response_200_1

Example data

Content-Type: 200-questions-with-statements
{"api":{"version":1,"build":17,"name":"Open Question API"},"timestamp":1.6250052007122636E9,"input":{"story":"When in my thoughts I'm coming back to my situation, I'd want make things happen now.","options":{"verbose":false}},"output":{"questions":[{"id":"5e3b233dbaac8fabfdd9357f881b91b9d5cef731ea62abe7e647b029_q01","markdown":"You said **back to my**, how can you do that, what specific easily achievable decision or action can you make?","html":"<span class=\"question\">You said <strong class=\"phrase\">back to my</strong>, how can you do that, what specific easily achievable decision or action can you make?</span>","statement":"Identifying and defining this element will make your path more achievable."}]},"oexp":{"verion":"0.9.3","privacy":"https://pocketconfidant.com/privacy/","terms":"https://pocketconfidant.com/terms/"}}

Example data

Content-Type: 200-questions-verbose-1
{"api":{"version":1,"build":17,"name":"Open Question API"},"timestamp":1.62500522054872E9,"input":{"story":"In all cases, I don’t like to intentionally look for a solution, an answer or a different perspective. Demanding something doesn’t seem to lead to a breakthrough. Humbly yes, surrendering my attempts to figure it all out on my own, creates new paths and opens doors. I just can't do this all the time.","options":{"verbose":true}},"output":{"questions":[{"id":"2a242fa9a032dea0ab696e26b6b29dcfeea9120b0ea4c0880d19454c_q01","markdown":"When you say **I do not like**, if you don't, then what do you like instead? Reflecting on what is there instead is a way to develop constructive thinking, leading to new perspectives and actions.","html":"<span class=\"question\">When you say <strong class=\"phrase\">I do not like</strong>, if you don't, then what do you like instead?</span><span class=\"statement\">Reflecting on what is there instead is a way to develop constructive thinking, leading to new perspectives and actions.</span>"},{"id":"6345f9953880d0d7243e2fd87a413dd82598a94de6c7706c6779acb0_q01","markdown":"You said **all the time**, what would you like to have happen instead? Reflecting on and defining this element precisely will help identifying what goals and actions to put in place.","html":"<span class=\"question\">You said <strong class=\"phrase\">all the time</strong>, what would you like to have happen instead?</span><span class=\"statement\">Reflecting on and defining this element precisely will help identifying what goals and actions to put in place.</span>"}]},"oexp":{"verion":"0.9.3","privacy":"https://pocketconfidant.com/privacy/","terms":"https://pocketconfidant.com/terms/"}}

Example data

Content-Type: 200-questions-verbose-2
{"api":{"version":1,"build":17,"name":"Open Question API"},"timestamp":1.625005169312257E9,"input":{"story":"When in my thoughts I'm coming back to my situation, I'd want make things happen now.","options":{"verbose":true}},"output":{"questions":[{"id":"5e3b233dbaac8fabfdd9357f881b91b9d5cef731ea62abe7e647b029_q01","markdown":"When saying **back to my**, how can you do that, what specific easily achievable decision or action can you make? Identifying and defining this element will make your path more achievable.","html":"<span class=\"question\">When saying <strong class=\"phrase\">back to my</strong>, how can you do that, what specific easily achievable decision or action can you make?</span><span class=\"statement\">Identifying and defining this element will make your path more achievable.</span>"}]},"oexp":{"verion":"0.9.3","privacy":"https://pocketconfidant.com/privacy/","terms":"https://pocketconfidant.com/terms/"}}

422

Example response inline_response_422

Example data

Content-Type: example-1
Up 
post /sentences
POST Sentences and Questions endpoint (postSentences)
Operation retrieves the analyzed text broken down into sentences with generated questions, plus additional metadata, such as timestamp, API versioning, and others. Unlike /questions/ endpoint, requests to /sentences/ endpoint supplies only questions which are specific to linguistic markers detected within each sentence. If the linguistic marker is absent, the output list of questions adjaccent to each sentences might be empty. This endpoint is useful if you want to provide a very context-specific details to your user.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter — <p>For a POST request, you can use the <code>body</code> property to pass a JSON string as input. Note that the request body should be a JSON string, while the headers should be a JSON object. The request body must contain non-empty string <code>story</code>, for which the questions will be generated.</p> <p>To control how questions are provided in the response output, <code>options</code> could be used.</p> <ul> <li><strong>verbosity</strong>: use <code>{&quot;verbose&quot;: false}</code> for compact questions and statements provided separately. Use <code>{&quot;verbose&quot;: true}</code> for questions and statements provided in the same varible.</li> </ul>
example: { "value" : { "story" : "In all cases, I don’t like to intentionally look for a solution, an answer or a different perspective. Demanding something doesn’t seem to lead to a breakthrough. Humbly yes, surrendering my attempts to figure it all out on my own, creates new paths and opens doors. I just can't do this all the time.", "options" : { "verbose" : true } } }

Request headers

Return type

inline_response_200

Example data

Content-Type: application/json
{
  "output" : {
    "sentences" : [ {
      "markdown" : "markdown",
      "questions" : [ {
        "phrase" : "phrase",
        "domain" : "domain",
        "scope" : "scope",
        "markdown" : "markdown",
        "statement" : "statement",
        "html" : "html",
        "id" : "id",
        "type" : "type",
        "methodology" : "methodology"
      }, {
        "phrase" : "phrase",
        "domain" : "domain",
        "scope" : "scope",
        "markdown" : "markdown",
        "statement" : "statement",
        "html" : "html",
        "id" : "id",
        "type" : "type",
        "methodology" : "methodology"
      } ],
      "html" : "html",
      "id" : "id"
    }, {
      "markdown" : "markdown",
      "questions" : [ {
        "phrase" : "phrase",
        "domain" : "domain",
        "scope" : "scope",
        "markdown" : "markdown",
        "statement" : "statement",
        "html" : "html",
        "id" : "id",
        "type" : "type",
        "methodology" : "methodology"
      }, {
        "phrase" : "phrase",
        "domain" : "domain",
        "scope" : "scope",
        "markdown" : "markdown",
        "statement" : "statement",
        "html" : "html",
        "id" : "id",
        "type" : "type",
        "methodology" : "methodology"
      } ],
      "html" : "html",
      "id" : "id"
    } ]
  },
  "input" : {
    "story" : "story"
  },
  "api" : {
    "build" : 6.027456183070403,
    "name" : "name",
    "version" : 0.8008281904610115
  },
  "oexp" : {
    "verion" : "verion",
    "terms" : "terms",
    "privacy" : "privacy"
  },
  "timestamp" : 1.4658129805029452
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Example response inline_response_200

Example data

Content-Type: 200-sentences-processed-with-statements
{"api":{"version":1,"build":17,"name":"Open Question API"},"timestamp":1.6250040037487648E9,"input":{"story":"In all cases, I don’t like to intentionally look for a solution, an answer or a different perspective. Demanding something doesn’t seem to lead to a breakthrough. Humbly yes, surrendering my attempts to figure it all out on my own, creates new paths and opens doors. I just can't do this all the time.","options":{"verbose":false}},"output":{"processed_text":"In cases, I don’t like intentionally look solution, answer different perspective. Demanding something doesn’t seem lead breakthrough. Humbly yes, surrendering attempts figure own, creates new paths opens doors. I can't time.","entities":[],"sentences":[{"id":"2a242fa9a032dea0ab696e26b6b29dcfeea9120b0ea4c0880d19454c","markdown":"In all cases, **I do not like** to intentionally look for a solution, an answer or a different perspective.","html":"In all cases, <strong class=\"phrase\">I do not like</strong> to intentionally look for a solution, an answer or a different perspective.","questions":[{"id":"2a242fa9a032dea0ab696e26b6b29dcfeea9120b0ea4c0880d19454c_q01","markdown":"When saying **I do not like**, if you don't, then what do you like instead?","html":"<span class=\"question\">When saying <strong class=\"phrase\">I do not like</strong>, if you don't, then what do you like instead?</span>","statement":"Reflecting on what is there instead is a way to develop constructive thinking, leading to new perspectives and actions."}]},{"id":"861ce447e81754daa07aa9b8cd5706a0655ca314eda4a924d54bff43","markdown":"Demanding something does not seem to lead to a breakthrough.","html":"Demanding something does not seem to lead to a breakthrough.","questions":[]},{"id":"5606a1ab45363a8316589fd2bbfdd5cdabd6dc7f58bb07a7e482f75c","markdown":"Humbly yes, surrendering my attempts to figure it all out on my own, creates new paths and opens doors.","html":"Humbly yes, surrendering my attempts to figure it all out on my own, creates new paths and opens doors.","questions":[]},{"id":"6345f9953880d0d7243e2fd87a413dd82598a94de6c7706c6779acb0","markdown":"I just can not do this **all the time**.","html":"I just can not do this <strong class=\"phrase\">all the time</strong>.","questions":[{"id":"6345f9953880d0d7243e2fd87a413dd82598a94de6c7706c6779acb0_q01","markdown":"When saying **all the time**, what would you like to have happen instead?","html":"<span class=\"question\">When saying <strong class=\"phrase\">all the time</strong>, what would you like to have happen instead?</span>","statement":"Reflecting on and defining this element precisely will help identifying what goals and actions to put in place."}]}]},"oexp":{"verion":"0.9.3","privacy":"https://pocketconfidant.com/privacy/","terms":"https://pocketconfidant.com/terms/"}}

Example data

Content-Type: 200-sentences-processed-verbose

422

Example response inline_response_422

Example data

Content-Type: example-1

Models

[ Jump to Methods ]

Table of Contents

  1. API - API description
  2. Exception - Exception output
  3. OEXP - OEXP description
  4. Question - Question object
  5. Sentence - Sentence object
  6. inline_response_200
  7. inline_response_200_1
  8. inline_response_200_1_output
  9. inline_response_200_2
  10. inline_response_200_2_output
  11. inline_response_200_input
  12. inline_response_200_output
  13. inline_response_422

API - API description Up

A model to describe API meta information like verion, build number, name
name (optional)
String
version
BigDecimal
build (optional)
BigDecimal

Exception - Exception output Up

A model to describe exceptions and errors in the output
message
String
statusCode
BigDecimal

OEXP - OEXP description Up

A model describing required elements according to the Open Ethics eXplainability Protocol
verion (optional)
String
privacy (optional)
String
terms (optional)
String

Question - Question object Up

A model for the question object
id
String Question ID for the block of text or a sentence
markdown
String Question text provided in markdown
html
String Question text in html format
statement (optional)
String A text statement providing additional information to the user, explaining how to deal with questions and how to proceed.
phrase (optional)
String
domain (optional)
String
methodology (optional)
String
scope (optional)
String
type (optional)
String

Sentence - Sentence object Up

A model for the sentence object
id
String unique sentence ID
markdown
String sentence text in markdown format
html
String sentence text in html format
questions (optional)
array[Question] list of questions

inline_response_200 Up

api
API
timestamp
BigDecimal
input
inline_response_200_input
output
inline_response_200_output
oexp
OEXP

inline_response_200_1 Up

api
API
timestamp
BigDecimal
input
inline_response_200_input
output
inline_response_200_1_output
oexp
OEXP

inline_response_200_1_output Up

questions
array[Question]

inline_response_200_2 Up

api
API
timestamp
BigDecimal
input
String
output
inline_response_200_2_output
oexp
OEXP

inline_response_200_2_output Up

successMessage
String
statusCode
BigDecimal

inline_response_200_input Up

story
String

inline_response_200_output Up

sentences
array[Sentence]

inline_response_422 Up

api
API
timestamp
BigDecimal
input
Object complete input object
output
Exception
oexp
OEXP