Sign in

v56

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014121451.1 MB
Questionnaire

Generate answers for a questionnaire

Starts background answer generation for an already-parsed questionnaire and returns a run handle immediately. Poll GET /v1/questionnaire/:id until answeredQuestions equals totalQuestions, then read the answers from its questions.

post/v1/questionnaire/{id}/auto-answer

Path parameters

idstring required

Response

questionnaireIdstring required

The questionnaire whose answers are being generated.

runIdstring required

Background run identifier for the generation job (Trigger.dev run id).

publicAccessTokenstring required

Token for tracking the run via Trigger.dev realtime. Optional — MCP/agent clients should poll GET /v1/questionnaire/:id instead.

statusstring required

Always 'generating' on a successful trigger. Poll GET /v1/questionnaire/:id; answers are ready once answeredQuestions equals totalQuestions.

totalQuestionsnumber required

Total number of questions in the questionnaire.

answeredQuestionsnumber required

Questions already answered at the moment generation was triggered (answers without a value are (re)generated).

messagestring required

Human-readable summary of what to do next.

Example response

{
  "questionnaireId": "qst_6a179d26c4ad2c1c816ee16d",
  "runId": "run_cmpotsz153eac0ultc1ya87f5",
  "publicAccessToken": "pat_...",
  "status": "generating",
  "totalQuestions": 23,
  "message": "Generating answers for 23 questions. Poll GET /v1/questionnaire/qst_... until answeredQuestions reaches totalQuestions."
}