Upload and parse questionnaire file | Comp AI API

Upload a security questionnaire file, extract questions, save the parsed questionnaire, and return its identifier and question count.

POST /v1/questionnaire/upload-and-parse/upload

Upload and parse questionnaire file

cURL

curl --request POST \
  --url https://api.trycomp.ai/v1/questionnaire/upload-and-parse/upload \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form file='@example-file' \
  --form 'organizationId=<string>'

const form = new FormData();
form.append('file', '<string>');
form.append('organizationId', '<string>');

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

options.body = form;

fetch('https://api.trycomp.ai/v1/questionnaire/upload-and-parse/upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/questionnaire/upload-and-parse/upload"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "organizationId": "<string>" }
headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

200

{
  "questionnaireId": "<string>",
  "totalQuestions": 123
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Body

multipart/form-data

file · file · required

Questionnaire file (PDF, image, XLSX, CSV, TXT)

organizationId · string · required

Organization ID

source · enum<string> · default: internal

Source of the upload

Available options: internal, external

Response

200 - application/json

Upload file, parse questions (no answers), save to DB, return questionnaireId

questionnaireId · string

totalQuestions · number