Create a questionnaire

POST

/api/v1/questionnaires

Send the questionnaire as a multipart upload with file set to an .xlsx or .docx. Processing is asynchronous: the response returns the questionnaire before any items exist, and items appear as the file is analysed. state moves through the processing states and settles in needs_input once every item has been answered.

For portal questionnaires (answered in a third-party portal) send portal_url and no file; nothing is processed. When title is omitted it is derived from the filename. The caller becomes the questionnaire’s owner. Rate limited to 3 per minute.

Authorizations

bearerAuth

Request Body^required

object

questionnaire

required

object

title

string

Defaults to the filename on create

description

string

deadline

string format: date

file

string format: binary

.xlsx or .docx; multipart create only

aasm_state

string

Allowed values: needs_input approved

Other values are dropped silently

portal_url

string format: uri

object

questionnaire

required

object

title

string

Defaults to the filename on create

description

string

deadline

string format: date

file

string format: binary

.xlsx or .docx; multipart create only

aasm_state

string

Allowed values: needs_input approved

Other values are dropped silently

portal_url

string format: uri

Responses

201

The created questionnaire

Response body

application/json

object

string

web_link

string format: uri

The questionnaire’s page in the web app

title

string

description

string | null

deadline

string | null format: date

state

string

Allowed values: new qa_complete mapping_complete items_generated processing_items needs_input approved

Processing and review state

filetype

string | null

Allowed values: pdf xlsx docx

framework

string | null

Allowed values: nist-csf-2.0 hecvat-3.06 hecvat-4.1 rh-1.0 cjis-5 cjis-6

portal_url

string | null format: uri

Set for questionnaires answered in a third-party portal

created_at

string format: date-time

updated_at

string format: date-time

owner

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

stats

Item counts. Discarded items are excluded.

object

total_items

integer

needs_input_items

integer

Items the AI could not answer confidently

auto_answered_items

integer

approved_items

integer

overall_completion_percentage

integer

<= 100

Approved items as a percentage of total

403

Insufficient scope, role, or credits

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/questionnaires \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'questionnaire={ "title": "example", "description": "example", "deadline": "2026-04-15", "file": "binary", "aasm_state": "needs_input", "portal_url": "https://example.com" }'

require 'uri'
require 'net/http'

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

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"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"questionnaire\"\r\nContent-Type: application/json\r\n\r\n{ \"title\": \"example\", \"description\": \"example\", \"deadline\": \"2026-04-15\", \"file\": \"binary\", \"aasm_state\": \"needs_input\", \"portal_url\": \"https://example.com\" }\r\n-----011000010111000001101001--\r\n"

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

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.responsehub.io/api/v1/questionnaires', [
  'multipart' => [
    [
        'name' => 'questionnaire',
        'contents' => '{ "title": "example", "description": "example", "deadline": "2026-04-15", "file": "binary", "aasm_state": "needs_input", "portal_url": "https://example.com" }'
    ]
  ]
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/questionnaires';
const form = new FormData();
form.append('questionnaire', '{ "title": "example", "description": "example", "deadline": "2026-04-15", "file": "binary", "aasm_state": "needs_input", "portal_url": "https://example.com" }');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

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/questionnaires"

  payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"questionnaire\"\r\nContent-Type: application/json\r\n\r\n{ \"title\": \"example\", \"description\": \"example\", \"deadline\": \"2026-04-15\", \"file\": \"binary\", \"aasm_state\": \"needs_input\", \"portal_url\": \"https://example.com\" }\r\n-----011000010111000001101001--\r\n")

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

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")

  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

{
  "questionnaire": {
    "title": "example",
    "description": "example",
    "deadline": "2026-04-15",
    "file": "binary",
    "aasm_state": "needs_input",
    "portal_url": "https://example.com"
  }
}

201example

Example^generated

{
  "id": "qu_1a2b",
  "web_link": "https://example.com",
  "title": "example",
  "description": "example",
  "deadline": "2026-04-15",
  "state": "new",
  "filetype": "pdf",
  "framework": "nist-csf-2.0",
  "portal_url": "https://example.com",
  "created_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z",
  "owner": {
    "id": 1,
    "name": "example",
    "email": "hello@example.com"
  },
  "stats": {
    "total_items": 1,
    "needs_input_items": 1,
    "auto_answered_items": 1,
    "approved_items": 1,
    "overall_completion_percentage": 1
  }
}

403example

Example^generated

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

422example

Example^generated

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

Create a questionnaire

Authorizations

Request Bodyrequired

Responses

201

403

422

Request Body^required