TRtrycompai
Questionnaire

Start questionnaire parsing

Changed on

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

post/v1/questionnaire/upload-and-parse

Request

  • Base URL
    https://api.trycomp.ai
  • Auth
    API key in header X-API-Key

Request body

organizationIdstring required

Organization ID (set automatically from auth context).

fileNamestring required

Name of the questionnaire file.

fileTypestring required

MIME type of the file (PDF, image, XLSX, CSV, TXT).

fileDatastring

Base64-encoded file contents. For the web UI / direct callers. AI/MCP clients should instead upload via /v1/uploads/presign and pass s3Key — base64 through an LLM is impractically slow. Provide exactly one of fileData or s3Key.

s3Keystring

Key of a file already uploaded via /v1/uploads/presign (purpose=questionnaire). The server fetches the bytes from storage — no base64 needed. Provide exactly one of fileData or s3Key.

Example request

{
  "organizationId": "org_abc123",
  "fileName": "vendor-security-questionnaire.xlsx",
  "fileType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "s3Key": "org_abc/uploads/questionnaire/1735000000-questionnaire.xlsx"
}

Response

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

runIdstring
publicAccessTokenstring

Changes