v1

latestOpenAPI 3.1.02026-08-067019120.8 KB
Sessions

Start a new interview session

Starts a new session for the given interview and returns the session ID. Any extra query parameters (other than i, secret, and key) are added to the interview's url_args variable.

get/api/session/new

Query parameters

istring required

Interview filename (e.g. docassemble.demo:data/questions/questions.yml).

secretstring

Encryption secret. If omitted and the interview uses encryption, a random secret is generated and returned.

Response

New session created.

istring required
sessionstring required
encryptedboolean required
secretstring

Only present when no secret was provided and the interview uses encryption.