curl \
-X POST 'MEILISEARCH_URL/render-template' \
-H 'Authorization: Bearer API_KEY' \
-H 'Content-Type: application/json' \
--data-binary '{
"template": {
"kind": "inlineDocumentTemplate",
"inline": "An inline document template rendered on {{doc.id}}"
},
"input": {
"kind": "inlineDocument",
"inline": { "id": "this document" }
}
}'client.renderTemplate({
template: {
kind: 'inlineDocumentTemplate',
inline: 'An inline document template rendered on {{doc.id}}'
},
input: {
kind: 'inlineDocument',
inline: { id: 'this document' }
}
})client.update_experimental_features({"renderRoute": True})
client.render_template(
template={
'kind': 'inlineDocumentTemplate',
'inline': 'An inline document template rendered on {{doc.id}}'
},
input={
'kind': 'inlineDocument',
'inline': {'id': 'this document'}
}
)Map<String, Boolean> features = new HashMap<>();
features.put("renderRoute", true);
client.experimentalFeatures(features);
Map<String, Object> template = new HashMap<>();
template.put("kind", "inlineDocumentTemplate");
template.put("inline", "Product {{doc.name}} is a {{doc.color}} {{doc.category}}.");
Map<String, Object> product = new HashMap<>();
product.put("name", "Nike Air Max");
product.put("color", "Black");
product.put("category", "Shoes");
Map<String, Object> input = new HashMap<>();
input.put("kind", "inlineDocument");
input.put("inline", product);
RenderTemplateRequest request = new RenderTemplateRequest()
.setTemplate(template)
.setInput(input);
client.renderTemplate(request);client.RenderTemplate(&meilisearch.RenderTemplateParams{
Template: meilisearch.Template{
Kind: meilisearch.InlineDocumentTemplate,
Inline: "An inline document template rendered on {{doc.id}}",
},
Input: &meilisearch.TempelateInput{
Kind: meilisearch.InlineDocument,
Inline: map[string]any{
"id": "this document",
},
},
})<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "7700",
CURLOPT_URL => "http://localhost:7700/render-template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'template' => [
'indexUid' => 'movies',
'embedder' => '<string>',
'fragment' => '<string>',
'inline' => '<unknown>',
'documentTemplateMaxBytes' => 1
],
'input' => [
'indexUid' => 'movies',
'id' => '<string>',
'inline' => '<unknown>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("http://localhost:7700/render-template")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"template\": {\n \"indexUid\": \"movies\",\n \"embedder\": \"<string>\",\n \"fragment\": \"<string>\",\n \"inline\": \"<unknown>\",\n \"documentTemplateMaxBytes\": 1\n },\n \"input\": {\n \"indexUid\": \"movies\",\n \"id\": \"<string>\",\n \"inline\": \"<unknown>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"template": "{{ doc.breed }} called {{ doc.name }}",
"rendered": "A Jack Russell called Iko"
}{
"message": "cannot find embedder `default` in index `movies`",
"code": "invalid_render_template",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#invalid_render_template_id"
}{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}{
"message": "Document with ID `9999` not found in index `movies`.",
"code": "render_document_not_found",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#render_document_not_found"
}Render template
Render a template, either fetched from the settings of an index (embedder document template, chat document template, indexing or search fragment) or provided inline, by injecting the given input (a document from an index, an inline document, or a search query).
Returns the template and the rendered result, allowing to preview how Meilisearch renders templates without indexing any document.
This route is only available when the renderRoute experimental feature is enabled.
curl \
-X POST 'MEILISEARCH_URL/render-template' \
-H 'Authorization: Bearer API_KEY' \
-H 'Content-Type: application/json' \
--data-binary '{
"template": {
"kind": "inlineDocumentTemplate",
"inline": "An inline document template rendered on {{doc.id}}"
},
"input": {
"kind": "inlineDocument",
"inline": { "id": "this document" }
}
}'client.renderTemplate({
template: {
kind: 'inlineDocumentTemplate',
inline: 'An inline document template rendered on {{doc.id}}'
},
input: {
kind: 'inlineDocument',
inline: { id: 'this document' }
}
})client.update_experimental_features({"renderRoute": True})
client.render_template(
template={
'kind': 'inlineDocumentTemplate',
'inline': 'An inline document template rendered on {{doc.id}}'
},
input={
'kind': 'inlineDocument',
'inline': {'id': 'this document'}
}
)Map<String, Boolean> features = new HashMap<>();
features.put("renderRoute", true);
client.experimentalFeatures(features);
Map<String, Object> template = new HashMap<>();
template.put("kind", "inlineDocumentTemplate");
template.put("inline", "Product {{doc.name}} is a {{doc.color}} {{doc.category}}.");
Map<String, Object> product = new HashMap<>();
product.put("name", "Nike Air Max");
product.put("color", "Black");
product.put("category", "Shoes");
Map<String, Object> input = new HashMap<>();
input.put("kind", "inlineDocument");
input.put("inline", product);
RenderTemplateRequest request = new RenderTemplateRequest()
.setTemplate(template)
.setInput(input);
client.renderTemplate(request);client.RenderTemplate(&meilisearch.RenderTemplateParams{
Template: meilisearch.Template{
Kind: meilisearch.InlineDocumentTemplate,
Inline: "An inline document template rendered on {{doc.id}}",
},
Input: &meilisearch.TempelateInput{
Kind: meilisearch.InlineDocument,
Inline: map[string]any{
"id": "this document",
},
},
})<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "7700",
CURLOPT_URL => "http://localhost:7700/render-template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'template' => [
'indexUid' => 'movies',
'embedder' => '<string>',
'fragment' => '<string>',
'inline' => '<unknown>',
'documentTemplateMaxBytes' => 1
],
'input' => [
'indexUid' => 'movies',
'id' => '<string>',
'inline' => '<unknown>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("http://localhost:7700/render-template")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"template\": {\n \"indexUid\": \"movies\",\n \"embedder\": \"<string>\",\n \"fragment\": \"<string>\",\n \"inline\": \"<unknown>\",\n \"documentTemplateMaxBytes\": 1\n },\n \"input\": {\n \"indexUid\": \"movies\",\n \"id\": \"<string>\",\n \"inline\": \"<unknown>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"template": "{{ doc.breed }} called {{ doc.name }}",
"rendered": "A Jack Russell called Iko"
}{
"message": "cannot find embedder `default` in index `movies`",
"code": "invalid_render_template",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#invalid_render_template_id"
}{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}{
"message": "Document with ID `9999` not found in index `movies`.",
"code": "render_document_not_found",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#render_document_not_found"
}Authorizations
An API key is a token that you provide when making API calls. Read more about how to secure your project.
Include the API key to the Authorization header, for instance:
-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'
If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:
const client = new MeiliSearch({ host: 'MEILISEARCH_URL', apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1' });
Body
Response
The rendered result is returned along with the template