Start questionnaire parsing | Comp AI API

Upload a questionnaire payload and start asynchronous parsing, returning a run ID for real-time progress tracking.

POST /v1/questionnaire/upload-and-parse

Start questionnaire parsing

cURL

curl --request POST \
  --url https://api.trycomp.ai/v1/questionnaire/upload-and-parse \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.trycomp.ai/v1/questionnaire/upload-and-parse', 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"

payload = {}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

{
  "runId": "<string>",
  "publicAccessToken": "<string>"
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Body

application/json

The body is of type object.

Response

200 - application/json

Upload file and trigger async parsing. Returns runId for realtime tracking.

runId · string

publicAccessToken · string