Close a session
POST https://api.129.212.147.181.sslip.io/v1/sessions/{session}/close
The session takes no more messages. Its history and answers stay readable until it is deleted or expires, and documents can still be made from a ready session.
Path parameters
Headers
Bearer dg_test_… or Bearer dg_live_…
The session_secret returned when the session started. For a
document, the secret of the session it was made from. Send it from
your server only.
Retrying with the same key and body returns the original response. Kept 24 hours.
Returns
200 OK: a Session object. The closed session.
Errors
| Status | Code | What to do |
|---|---|---|
| 401 | session_secret_missing | Send Docgen-Session-Secret: the session_secret returned when the session started. |
| 404 | session_not_found | Check the ID, and that Docgen-Session-Secret is the secret returned when the session started. |
| 410 | session_deleted | The session was deleted with its conversation and answers. Start a new one. |
Any endpoint can also return the common errors (bad key, rate limit, idempotency).