# Builder

Hosted UI for end users to draft their document.

## Create a new builder session

 - [POST /api/builder/sessions](https://developers.docue.com/embeddable-builder-api/openapi/builder/createbuildersession.md): A builder session is required to start drafting a document with the Embeddable Builder (EB). Each session is isolated and contains all document-related data. Once the session ends, all data is deleted from our servers.

To create a session, you need:
- A template ID - Get this from our Template Listing API or let the end-user pick one via the hosted Template Browser UI.
- A list of languages - The languages must match the languages available for the selected template. The language determines the final document's language that the end-user drafts. Currently, only one language can be provided.
- A document name - Acts like a file name. It's shown in the builder UI and can be edited by the end-user.

Participant details

You can provide end-user details, such as display name and email, for your reference. These will be required later for collaboration features like commenting, but they are not currently in use. You can use the External ID field to store your internal user ID, which you can later use to match our participants with your users if needed.

Redirect URL

After creating a session, you'll get a one-time URL to send the end-user to our hosted builder UI. Opening the link creates a secure session with access to that document only.

The redirect URL is valid for 15 minutes.

#### Handlers
You need to provide handlers that redirect the end user back to your service after drafting.

Success handler
The user is redirected to this URL after completing the drafting session and filling in all the required information. The document is then considered "ready" and cannot be altered. Please note that the endpoint may be called multiple times if users navigates back to our builder via browser history.

Cancel handler
The user is redirected to this URL after canceling the drafting session. The builder session remains intact. If the user navigates back to our UI using browser history, they can resume drafting. Therefore, it is possible for this handler to be called multiple times.

Delete handler
The user is redirected to this URL after the document is deleted. Document can be deleted via API and end-users can delete the document through the UI. Once deleted, the document cannot be altered, but it remains accessible via the API for a certain period before being permanently deleted. If the user navigates back to the builder after deletion, they will be automatically redirected to this handler. Consequently, this endpoint may be called multiple times.

Error handler
The user is redirected to this URL when an unexpected error occurs.

#### Handler url parameters

Handler URLs are appended (existing parameters will remain unchanged) with the following query parameters:
| Parameter       | Description                                          |
| --------------- | ---------------------------------------------------- |
| session_id    | Builder session ID                                   |
| participant_id| Builder participant ID                               |

## Retrieve details of existing builder session

 - [GET /api/builder/sessions/{session_id}](https://developers.docue.com/embeddable-builder-api/openapi/builder/getbuildersession.md): Returns details of the existing builder session.

## Delete builder session

 - [DELETE /api/builder/sessions/{session_id}](https://developers.docue.com/embeddable-builder-api/openapi/builder/deletebuildersession.md): Invalidates the builder session. The session is no longer accessible via the API after deletion. If the end user is still in the builder, they are redirected to the delete handler URL you provided when creating the session.

## Get contract state and signees

 - [GET /api/builder/sessions/{session_id}/contract](https://developers.docue.com/embeddable-builder-api/openapi/builder/getbuildersessioncontract.md): Get contract's state and list of signees.

## Update contract state and appearance

 - [PATCH /api/builder/sessions/{session_id}/contract](https://developers.docue.com/embeddable-builder-api/openapi/builder/patchbuildersessioncontract.md): Update the contract's state values and appearance using JSON Patch (RFC 6902) operations.
The available operations depend on the path, as does the value.

See more detailed description and examples here.

## Finalize contract

 - [POST /api/builder/sessions/{session_id}/contract/finalize](https://developers.docue.com/embeddable-builder-api/openapi/builder/finalizebuildersessioncontract.md): Finalize the current builder session contract. Once finalized, the document becomes read-only and can no longer be patched. The document PDF and HTML can still be downloaded.

## Get HTML

 - [GET /api/builder/sessions/{session_id}/html](https://developers.docue.com/embeddable-builder-api/openapi/builder/getbuildersessionhtml.md): Retrieve the rendered HTML of the builder session document. This matches the PDF contents but in HTML format for previewing or custom rendering flows.

## Get PDF

 - [GET /api/builder/sessions/{session_id}/pdf](https://developers.docue.com/embeddable-builder-api/openapi/builder/getbuildersessionpdf.md): Get rendered PDF for the builder session.

## Re-authenticate existing participant

 - [POST /api/builder/sessions/{session_id}/participants/{participant_id}/authenticate](https://developers.docue.com/embeddable-builder-api/openapi/builder/reauthenticateparticipant.md): If you want to re-authenticate an existing participant in an ongoing Builder session, you can use this endpoint.

See details about the url in create builder session.