curl --request GET \
--url https://api.quiva.ai/file-generator/templates/{key} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.quiva.ai/file-generator/templates/{key}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.quiva.ai/file-generator/templates/{key}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.quiva.ai/file-generator/templates/{key}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.quiva.ai/file-generator/templates/{key}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.quiva.ai/file-generator/templates/{key}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quiva.ai/file-generator/templates/{key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"body": {
"key": "invoice-template",
"label": "Standard Invoice",
"source": {
"key": "invoice.docx",
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
},
"output": {
"content_type": "application/pdf",
"bucket": "microstrate-documents",
"folder": "invoices",
"name": "invoice-{invoice_number}"
},
"signatories": [
{
"name": "{client_name}",
"email": "{client_email}",
"validity": {
"day": 7
},
"order": 0
}
],
"sub_templates": []
}
}{
"error": "\"key\" is required"
}{
"error": "Authorization header with a bearer token is required"
}{
"error": "server error"
}Get template
Retrieve a single document template by key.
Pass ?draft=true to fetch the draft version; omit it (or set false) to fetch the published version. A template may exist as draft only (never published), published only (draft deleted after publish), or both — the two versions are independent records.
The returned source.key points at the DOCX file in microstrate-documents object storage bucket, that’s being rendered when the template is triggered. Fields such as output.name and signatories[].name/email may contain expression placeholders (e.g. {client_name}) that are resolved against the trigger payload.
curl --request GET \
--url https://api.quiva.ai/file-generator/templates/{key} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.quiva.ai/file-generator/templates/{key}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.quiva.ai/file-generator/templates/{key}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.quiva.ai/file-generator/templates/{key}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.quiva.ai/file-generator/templates/{key}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.quiva.ai/file-generator/templates/{key}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quiva.ai/file-generator/templates/{key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"body": {
"key": "invoice-template",
"label": "Standard Invoice",
"source": {
"key": "invoice.docx",
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
},
"output": {
"content_type": "application/pdf",
"bucket": "microstrate-documents",
"folder": "invoices",
"name": "invoice-{invoice_number}"
},
"signatories": [
{
"name": "{client_name}",
"email": "{client_email}",
"validity": {
"day": 7
},
"order": 0
}
],
"sub_templates": []
}
}{
"error": "\"key\" is required"
}{
"error": "Authorization header with a bearer token is required"
}{
"error": "server error"
}Authorizations
Query Parameters
Response
Template retrieved successfully. The example below shows a fully configured invoice template: a DOCX source rendered to PDF, a templated output filename, and one signatory whose details are resolved from the trigger payload.