Templates

GET /v1/templates

List Templates

D46(f): the CLI's `template list`.

Query

• limit integer (>= 1, <= 200) default 50
• offset integer (>= 0) default 0

Responses

• 200 TemplatePage
• 4xx 5xx application/problem+json; see the error reference.

POST /v1/templates

Create Template

Request body (application/json, required)

Responses

• 201 TemplateOut
• 4xx 5xx application/problem+json; see the error reference.

GET /v1/templates/{tpl_id}

Get Template

D46(f): the CLI's `template pull` — the definition round-trips.

Path

• tpl_id string

Responses

• 200 TemplateOut
• 4xx 5xx application/problem+json; see the error reference.

PATCH /v1/templates/{tpl_id}

Patch Template

D54/TE-6: replaces the parts given and bumps `version`. Documents already created from the template are unaffected.

Path

• tpl_id string

Request body (application/json, required)

Responses

• 200 TemplateOut
• 4xx 5xx application/problem+json; see the error reference.

DELETE /v1/templates/{tpl_id}

Delete Template

D54: soft delete — the template disappears from list/get/use; documents created from it are unaffected.

Path

• tpl_id string

Responses

• 204 no body
• 4xx 5xx application/problem+json; see the error reference.

POST /v1/templates/{tpl_id}/duplicate

Duplicate Template

T-5: a new template (version 1) from the same PDF and definition.

Path

• tpl_id string

Request body (application/json)

Type: DuplicateTemplateIn | null

Responses

• 201 TemplateOut
• 4xx 5xx application/problem+json; see the error reference.

POST /v1/templates/{tpl_id}/use

Use Template

Path

• tpl_id string

Request body (application/json, required)

Responses

• 201 DocumentOut
• 4xx 5xx application/problem+json; see the error reference.