Render a Liquid template against sample payloads

POST

/api/v1/utils/render_liquid_template

const url = 'https://app.prefactorai.com/api/v1/utils/render_liquid_template';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '"Hello {{name}}"'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://app.prefactorai.com/api/v1/utils/render_liquid_template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '"Hello {{name}}"'

Authorizations

authorization

Request Body

Liquid template to render with Prefactor’s span summary renderer

string

<= 10000 characters

Example

Hello {{name}}

Responses

200

Success

application/json

object

results

required

Per-sample render results in the same order as the request samples

Array<object>

UtilsRenderLiquidTemplateResult

Rendered output and errors for one sample

object

errors

required

Parse and render errors for this sample

Array<string>

rendered

required

One of:

string
Null

string

status

required

string

Allowed values: success

Example

{
  "results": [
    {
      "errors": [],
      "rendered": "Hello world"
    }
  ],
  "status": "success"
}

default

Error

application/json

One of:

object

code

required

string

Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_state alert_unknown alert_already_cleared invalid_value required_value idempotency_key_already_used temporarily_unavailable conflict

message

required

string

status

required

string

Allowed values: error

Example

{
  "code": "bad_request",
  "status": "error"
}