Skip to navigation
Form-fill API Referencejobs

Submit a job

Queue a document for Questionnaire filling or question answering. Returns immediately; poll GET /v1/jobs/{id} or use callback_url.

Authentication

AuthorizationBearer

Customer API key or OAuth 2.0 access token (scope formfill:process)

Headers

idempotency-keystring or nullOptional

Optional, recommended: retrying with the same key and body returns the original job instead of a new one (per organization, 24 h). 1-128 of [A-Za-z0-9_.:-]

Request

This endpoint expects an object.
typeenumRequired

questionnaire: fill a FHIR Questionnaire. questions: answer a list of free-form questions

Allowed values:
documentobjectRequired
questionnairemap from strings to any or nullOptional

FHIR R4 Questionnaire resource (required for type questionnaire)

questionslist of strings or objects or nullOptional

Questions (required for type questions): bare strings or Question objects, at most 100

optionsobjectOptional
callback_urlstring or nullOptional<=2048 characters

HTTPS URL to notify when the job finishes (see the job.finished webhook). Must resolve to public addresses only

Response

Idempotent retry: the job already created with this Idempotency-Key

idstring
typeenum
Allowed values:
statusenum

expired: the result was downloaded or the 24-hour window passed

created_atstring

UTC, YYYY-MM-DDTHH:MM:SSZ

expires_atstring
When the job and any unread result are deleted
result_availableboolean
started_atstring or nullOptional
completed_atstring or nullOptional
errorobject or nullOptional

Present when status is failed

webhookobject or nullOptional

Present when a callback_url was given

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error