Skip to content

Embeddable Builder API (0.1.0)

Authentication

All endpoints in this API require Bearer authentication using an API key. Include the API key obtained from the customer portal in the Authorization header of each request, formatted as follows:

Authorization: Bearer <api_key>
Download OpenAPI description
Languages
Servers
Production
https://api.builder.docue.com/

Workspaces

Endpoint for fetching information about the authenticated workspace. It can be used to test if the API authentication works.

Operations

Templates

Fetch a list of all available templates. Use this if you want to create a fully customized UI for selecting templates. If you prefer to use our ready-made UI, you can use the Template Browser instead.

Operations

List available templates

Request

Security
APIKey
Query
per_pageinteger[ 1 .. 200 ]

Number of items per page.

Default 15
Example: per_page=20
pageinteger>= 1

Page number to retrieve. Defaults to 1.

Default 1
Example: page=1
includestring

Comma delimited list of relationships to include.
Available includes: jurisdictions, languages

Example: include=languages,jurisdictions
Headers
Acceptstringrequired

Specify the response format.

Value"application/json"
curl -i -X GET \
  'https://api.builder.docue.com/api/templates?per_page=20&page=1&include=languages%2Cjurisdictions' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>'

Responses

Successful response with a list of templates.

Bodyapplication/json
dataArray of objects(App.Data.Template.TemplateData.TemplateData)
metaobject(PaginationData)
Response
application/json
{ "data": [ {} ], "meta": { "current_page": 1, "first_page_url": "https://api.builder.docue.com/api/templates?page=1", "from": 1, "last_page": 2, "last_page_url": "https://api.builder.docue.com/api/templates?page=2", "next_page_url": "https://api.builder.docue.com/api/templates?page=2", "path": "https://api.builder.docue.com/api/templates", "per_page": 15, "prev_page_url": null, "to": 15, "total": 30 } }

Get a single template

Request

Security
APIKey
Path
template_idstring(uuid)required

The UUID of the template to retrieve.

Example: 7f3f5f62-2c69-7d4e-8a3d-9c0f0e2c5f3a
Query
includestring

Comma delimited list of relationships to include.
Available includes: jurisdictions, languages

Example: include=languages,jurisdictions
Headers
Acceptstringrequired

Specify the response format.

Value"application/json"
curl -i -X GET \
  'https://api.builder.docue.com/api/templates/7f3f5f62-2c69-7d4e-8a3d-9c0f0e2c5f3a?include=languages%2Cjurisdictions' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>'

Responses

Successfully retrieved the template.

Bodyapplication/json
dataobject(App.Data.Template.TemplateData.TemplateData)
Response
application/json
{ "data": { "id": "7f3f5f62-2c69-7d4e-8a3d-9c0f0e2c5f3a", "title": {}, "description": {}, "short_description": {}, "default_document_name": {}, "created_at": "2025-03-22T14:30:00Z", "updated_at": "2025-03-22T14:30:00Z", "languages": [], "jurisdictions": [] } }

Template browser

Hosted UI for end users to select the appropriate template. Use this if you want to take advantage of our UI.

Operations

Builder

Hosted UI for end users to draft their document.

Operations