Ask a question

POST

/api/v1/questions

Answering runs asynchronously: the response is 202 Accepted with the question in its initial state. Poll GET /api/v1/questions/{id} until state is complete. Rate limited to 10 per minute. Consumes credits. Viewers may ask questions; this is the one write that a read-only role is allowed, though the token still needs the write scope.

Authorizations

bearerAuth

Request Body^required

application/json

object

question

required

object

question

required

string

custom_prompt

string

Extra instructions for the model

answer_detail_level

integer

default: 1

Allowed values: 0 1 2

0 = low, 1 = normal, 2 = high

Responses

202

Accepted; poll for the answer

Response body

application/json

object

string

question

string

answer

string | null

Set once state is complete

verbatim_answer

boolean

The answer was copied verbatim from a single knowledge base item

state

string

Allowed values: new ready_to_answer references_fetched answered confidence_calculated complete

confidence

number | null

<= 1

confidence_rationale

string | null

answer_detail_level

string

Allowed values: low normal high

custom_prompt

string | null

requires_attention

boolean

attention_points

Array<string> | null

Points a human should check before relying on the answer

sufficient_context

boolean | null

Whether the knowledge base held enough to answer

created_at

string format: date-time

updated_at

string format: date-time

user

One of:

object
null

The member who owns or answered a record. id is the numeric database ID.

object

integer

name

string

email

string format: email

403

Out of credits, or no active subscription (usage_blocked)

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

422

The record could not be saved

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

Request

curl --request POST \
  --url https://app.responsehub.io/api/v1/questions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "question": { "question": "example", "custom_prompt": "example", "answer_detail_level": 0 } }'

require 'uri'
require 'net/http'

url = URI("https://app.responsehub.io/api/v1/questions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{ \"question\": { \"question\": \"example\", \"custom_prompt\": \"example\", \"answer_detail_level\": 0 } }"

response = http.request(request)
puts response.read_body

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.responsehub.io/api/v1/questions', [
  'body' => '{ "question": { "question": "example", "custom_prompt": "example", "answer_detail_level": 0 } }',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/questions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"question":{"question":"example","custom_prompt":"example","answer_detail_level":0}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://app.responsehub.io/api/v1/questions"

  payload := strings.NewReader("{ \"question\": { \"question\": \"example\", \"custom_prompt\": \"example\", \"answer_detail_level\": 0 } }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Request body example

Example^generated

{
  "question": {
    "question": "example",
    "custom_prompt": "example",
    "answer_detail_level": 0
  }
}

202example

Example^generated

{
  "id": "q_1a2b",
  "question": "example",
  "answer": "example",
  "verbatim_answer": true,
  "state": "new",
  "confidence": 0.85,
  "confidence_rationale": "example",
  "answer_detail_level": "low",
  "custom_prompt": "example",
  "requires_attention": true,
  "attention_points": [
    "example"
  ],
  "sufficient_context": true,
  "created_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z",
  "user": {
    "id": 1,
    "name": "example",
    "email": "hello@example.com"
  }
}

403example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

422example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

Ask a question

Authorizations

Request Bodyrequired

Responses

202

403

422

Request Body^required